You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+9-8
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to `panther-analysis`
2
2
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.
4
4
5
5
## What makes a good detection?
6
6
@@ -19,18 +19,18 @@ Before submitting your pull request, make sure to:
19
19
- Write or update relevant unit tests
20
20
- Redact any sensitive information or PII from example logs
21
21
- 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
+
```
27
27
28
28
## Pull Request process
29
29
30
30
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
31
31
2. Commit both the Python and Metadata files
32
32
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.
34
34
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
35
35
36
36
## Code of Conduct
@@ -42,4 +42,5 @@ in all of your interactions with this project.
42
42
43
43
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).
44
44
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!
0 commit comments