Skip to content

Commit 5132f6a

Browse files
authored
Update CONTRIBUTING.md (#1420)
1 parent 4b6e485 commit 5132f6a

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

CONTRIBUTING.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to `panther-analysis`
22

3-
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.
3+
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.
44

55
## What makes a good detection?
66

@@ -19,18 +19,18 @@ Before submitting your pull request, make sure to:
1919
- Write or update relevant unit tests
2020
- Redact any sensitive information or PII from example logs
2121
- Format, lint, and test your changes to ensure CI tests pass, using the following commands:
22-
```bash
23-
make fmt
24-
make lint
25-
make test
26-
```
22+
```bash
23+
make fmt
24+
make lint
25+
make test
26+
```
2727

2828
## Pull Request process
2929

3030
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
3131
2. Commit both the Python and Metadata files
3232
3. Write a clear commit message
33-
4. Open a [Pull Request](https://github.com/panther-labs/panther-analysis/pulls).
33+
4. Open a [Pull Request](https://github.com/panther-labs/panther-analysis/pulls) against the `develop` branch.
3434
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
3535

3636
## Code of Conduct
@@ -42,4 +42,5 @@ in all of your interactions with this project.
4242

4343
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).
4444

45-
Thank you again for your contributions, and we look forward to working together!
45+
Thank you again for your contributions, and we look forward to working together!
46+

0 commit comments

Comments
 (0)