Thank you for your interest in contributing to this project! We welcome contributions of all kinds: issues, bug reports, new rules, and pull requests. For just about everything, opening an issue is fine. Opening a pull request would be even better.
Please search existing issues before opening a new one. This helps avoid duplicates and ensures discussions stay organized.
If you encounter a bug, please open an issue and include:
- A clear description of the problem
- Steps to reproduce the bug
- Your configuration file (if applicable)
- A minimal reproducible example
Have an idea for a new rule? Great! You can:
- Open an issue to discuss it, or
- Jump straight in with a pull request
Please explain the motivation behind the rule, its intended use cases, and provide examples if possible.
We love pull requests!! Before submitting:
- Ensure your code follows the existing style and passes all tests.
- Include tests for any new features or rules. Every rule requires a test.
- Update documentation if needed.
- Link the related issue in the PR description (if applicable).
Thank you for helping make this project better!
If you discover a security vulnerability, please do not open a public issue. Instead, refer to our responsible disclosure guidelines for how to report it.