|
| 1 | +# Contributing to Chproxy |
| 2 | + |
| 3 | +Thank you for considering to contribute to CHProxy. We value your help on the project, whether it is by: |
| 4 | + |
| 5 | +- Reporting a bug |
| 6 | +- Improving documentation |
| 7 | +- Submitting a fix |
| 8 | +- Proposing new features |
| 9 | + |
| 10 | +## Contributing Code |
| 11 | + |
| 12 | +We use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), so all code changes are made via pull requests. |
| 13 | + |
| 14 | +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](https://github.com/ContentSquare/chproxy/issues) before creating your PR. |
| 15 | + |
| 16 | +To create a PR: |
| 17 | + |
| 18 | +1. Fork the repo and create your branch from `master`. |
| 19 | +2. If you've added code that should be tested, add tests. |
| 20 | +3. If you've changed APIs or added a new feature, update the documentation. |
| 21 | +4. Ensure the test suite passes. |
| 22 | +5. Make sure your code lints. |
| 23 | + |
| 24 | +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. |
| 25 | + |
| 26 | +Note that we do not accept "cosmetic PRs" that functionally do not change anything as they have little value for the project. |
| 27 | +## Reporting bugs |
| 28 | + |
| 29 | +We use GitHub issues to track public bugs. Report a bug by [opening an issue](https://github.com/ContentSquare/chproxy/issues). You can use the Bug Report template to report an issue with Chproxy. |
| 30 | + |
| 31 | +**Great Bug Reports** tend to have: |
| 32 | + |
| 33 | +- A quick summary and/or background |
| 34 | +- Steps to reproduce |
| 35 | +- What you expected would happen |
| 36 | +- What actually happened |
| 37 | +- Notes: |
| 38 | + - Do you have any metrics available that might be relevant? |
| 39 | + - Do you suspect a root cause? |
| 40 | + - Anything else that can contribute to the report. |
| 41 | + |
| 42 | +## Improving the documentation |
| 43 | + |
| 44 | +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](https://github.com/ContentSquare/chproxy/issues). |
| 45 | + |
| 46 | +## License |
| 47 | + |
| 48 | +By contributing, you agree that your contributions will be licensed under its MIT License. |
0 commit comments