From 19788b10316f58fdc79fae5b66276d842460afb1 Mon Sep 17 00:00:00 2001 From: Panos Sakkos Date: Wed, 6 Nov 2024 17:55:47 +0200 Subject: [PATCH] update CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 24ab6793e..7fa3b49f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to `panther-analysis` -Thank you for your interest in contributing to Panther's open-source ruleset! We appreciate all types of contributions, including new detection rules, feature requests, and bug reports. +Thank you for your interest in contributing to Panther's open-source ruleset! We appreciate all types of contributions, including new detection rules, feature requests, and bug reports. ## What makes a good detection? @@ -19,18 +19,18 @@ Before submitting your pull request, make sure to: - Write or update relevant unit tests - Redact any sensitive information or PII from example logs - Format, lint, and test your changes to ensure CI tests pass, using the following commands: - ```bash - make fmt - make lint - make test - ``` + ```bash + make fmt + make lint + make test + ``` ## Pull Request process 1. Make desired detection changes. This may include creating new detections in existing log type directories, creating new log type directories, updating existing detections, etc 2. Commit both the Python and Metadata files 3. Write a clear commit message -4. Open a [Pull Request](https://github.com/panther-labs/panther-analysis/pulls). +4. Open a [Pull Request](https://github.com/panther-labs/panther-analysis/pulls) against the `develop` branch. 5. Once your PR has been approved by code owners, if you have merge permissions, merge it. If you do not have merge permissions, leave a comment requesting a code owner merge it for you ## Code of Conduct @@ -42,4 +42,5 @@ in all of your interactions with this project. If you need assistance at any point, feel free to open a support ticket, or reach out to us on [Panther Community Slack](https://pnthr.io/community). -Thank you again for your contributions, and we look forward to working together! \ No newline at end of file +Thank you again for your contributions, and we look forward to working together! +