1bcc6c8b2b
- Simplify `README.md` by creating and moving some documentation to `architecture.md`. - Add more documentation for state handling between layers. - Improve some documentation to use clearer language.
1.4 KiB
1.4 KiB
Contributing
- Love your input! Contributing to this project should be as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
Pull request process
- GitHub flow with GitOps is used
- Your pull requests are actively welcomed.
- The steps:
- Fork the repo and create your branch from master.
- If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- 🙏 DO
- Document your changes in the pull request
- ❗ DON'T
- Do not update the versions, current version is only set by the maintainer and updated automatically by bump-everywhere
License
By contributing, you agree that your contributions will be licensed under its GNU General Public License v3.0.
Read more
- See tests for testing
- See extend script for quick steps to extend scripts
- See architecture overview to deep dive into privacy.sexy codebase