Thank you for considering to contribute to CHProxy. We value your help on the project, whether it is by:
- Reporting a bug
- Improving documentation
- Submitting a fix
- Proposing new features
We use Github Flow, so all code changes are made via pull requests.
Before making a pull request, make sure to communicate what you aim to achieve with your PR to smoothen the process. Consider opening an issue before creating your PR.
To create a PR:
- 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 or added a new feature, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
For first time contributors running the CI pipelines require explicit maintainer approval. Ping one of the maintainers on your PR to ask for a CI run. Thank you for your understanding.
Note that we do not accept "cosmetic PRs" that functionally do not change anything as they have little value for the project.
We use GitHub issues to track public bugs. Report a bug by opening an issue. You can use the Bug Report template to report an issue with Chproxy.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- What you expected would happen
- What actually happened
- Notes:
- Do you have any metrics available that might be relevant?
- Do you suspect a root cause?
- Anything else that can contribute to the report.
We greatly value improvements to the documentation! If you feel like certain areas of Chproxy are not well documented, but are unsure how to document them, you can also help by opening an issue.
By contributing, you agree that your contributions will be licensed under its MIT License.