Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.49 KB

Contributing to pypanther-starter-kit

Thank you for your interest in contributing to the pypanther-starter-kit! We appreciate all types of contributions, including default configurations, feature requests, and bug reports.

The purpose of this repository is to help Panther users bootstrap their new pypanther repository for v2 rule management, including custom rules, overrides, helper functions, and more.

Testing your changes

Before submitting your pull request, make sure to:

  • Redact any sensitive information or PII from example logs
  • Format, lint, and test your changes to ensure CI tests pass, using the following commands: 
    make fmt
make lint
make test

Pull Request process

  1. Make desired changes
  2. Commit the relevant files
  3. Write a clear commit message
  4. Open a Pull Request against the main 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

Please follow the Code of Conduct in all of your interactions with this project.

Need help?

If you need assistance at any point, feel free to open a support ticket, or reach out to us on Panther Community Slack.

Thank you again for your contributions, and we look forward to working together!