Sergey Polzunov
1fb60d6475
* first pass * Adding a dedicated code checking workflow * Type fixes * linting config and python version bump * Type hints * Drop incorrect config option * More fixes * Style fixes * CI adjustments * Pyproject fixes * CI & pyproject fixes * Proper version bump * Tests formatting * Resolve cirtular dependency * Test fixes * Make sure the tests are formatted correctly * Check tweaks * Bumping python version in CI images * Pin marshmallow do 3.x because 4.x is not supported * License fix * Convert path to str * Making myself a codeowner * Missing kwargs param * Adding a missing kwargs to `set_score` * Update .github/CODEOWNERS Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com> * Dropping unnecessary raise * Dropping skipped test * Drop unnecessary var * Drop unused commented-out func * Disable typehinting for the whole func * Update linting command * Invalid type hist on the input param * Incorrect field type * Incorrect value used fix * Stricter values check * Simpler function call * Type condition fix * TOML formatter fix * Simpligy output conditions * Formatting * Use proper types instead of aliases * MITRE attack fixes * Using pathlib.Path for an argument * Use proper method to update a set from a dict * First round of `ruff` fixes * More fixes * More fixes * Hack against cyclic dependency * Ignore `PLC0415` * Remove unused markers * Cleanup * Fixing the incorrect condition * Update .github/CODEOWNERS Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com> * Set explicit default values for optional fields * Update the guidelines * Adding None Defaults --------- Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com> Co-authored-by: eric-forte-elastic <eric.forte@elastic.co>
1.4 KiB
1.4 KiB
Bug - Guidelines
These guidelines serve as a reminder set of considerations when addressing a bug in the code.
Documentation and Context
- Provide detailed documentation (description, screenshots, reproducing the bug, etc.) of the bug if not already documented in an issue.
- Include additional context or details about the problem.
- Ensure the fix includes necessary updates to the release documentation and versioning.
Code Standards and Practices
- Code follows established design patterns within the repo and avoids duplication.
- Ensure that the code is modular and reusable where applicable.
Testing
- New unit tests have been added to cover the bug fix or edge cases.
- Existing unit tests have been updated to reflect the changes.
- Provide evidence of testing and detecting the bug fix (e.g., test logs, screenshots).
- Validate that any rules affected by the bug are correctly updated.
- Ensure that performance is not negatively impacted by the changes.
- Verify that any release artifacts are properly generated and tested.
- Conducted system testing, including fleet, import, and create APIs (e.g., run
make test-cli,make test-remote-cli,make test-hunting-cli)
Additional Checks
- Verify that the bug fix works across all relevant environments (e.g., different OS versions).
- Confirm that the proper version label is applied to the PR
patch,minor,major.