37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
|
# Contributing to LitterBox
|
|||
|
|
|
|||
|
|
Contributions are welcome and encouraged. The following guidelines outline how to contribute effectively to this project.
|
|||
|
|
|
|||
|
|
## Acceptable Contributions
|
|||
|
|
|
|||
|
|
- Bug fixes
|
|||
|
|
- Improvements to existing code, analysis modules, or documentation
|
|||
|
|
- Addition of new features or enhancements (user interface, API, analysis modules, automation, etc.)
|
|||
|
|
- Tooling improvements for analysis or developer workflows
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Submitting Pull Requests
|
|||
|
|
|
|||
|
|
- Open pull requests against the `main` branch.
|
|||
|
|
- Pull requests are reviewed for code quality, security, and alignment with project goals.
|
|||
|
|
- Pull requests must pass all automated tests, if applicable, before merging.
|
|||
|
|
- If changes are requested or continuous integration checks fail, add new commits to the same branch.
|
|||
|
|
- For guidance on submitting a pull request, refer to [GitHub’s documentation on forking and pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks).
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## Branching Model
|
|||
|
|
|
|||
|
|
This repository uses the `main` branch for all development. Long-lived feature or release branches are not maintained.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## License
|
|||
|
|
|
|||
|
|
By contributing to LitterBox, you agree your contributions will be licensed under the terms in the [LICENSE](LICENSE) file.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
Thank you for helping make LitterBox better!
|