|
| 1 | +# Contributing to DejaCode |
| 2 | + |
| 3 | +Thank you for your interest in contributing to AboutCode projects. |
| 4 | +Please **read the following guidelines carefully before submitting a pull request**. |
| 5 | + |
| 6 | +## Pull request rules |
| 7 | + |
| 8 | +- **Attach your PR to an existing issue.** Discuss the approach and implementation |
| 9 | + details in the issue first, before writing any code. Please note that if the issue |
| 10 | + has already been assigned to someone else, you are welcome to comment on it, but it |
| 11 | + would be best to contribute code in such a case only if you are invited to do so. |
| 12 | + |
| 13 | +- **You must fully understand your code changes** and be able to explain them |
| 14 | + clearly. If you cannot walk a reviewer through your changes, the PR will not |
| 15 | + be accepted. |
| 16 | + |
| 17 | +- **Write your own descriptions, comments, and documentation.** All written |
| 18 | + content in a PR must be authored by a human. |
| 19 | + |
| 20 | +- **Disclose any AI usage.** If any part of your contribution was generated or |
| 21 | + assisted by AI, you must disclose this and specify the tools used. |
| 22 | + |
| 23 | +- **Include tests.** Any code change or addition must be accompanied by proper |
| 24 | + unit tests. Untested code will not be merged. |
| 25 | + |
| 26 | +**Any PR that violates these rules will be closed.** |
| 27 | + |
| 28 | +## Pull request tips |
| 29 | + |
| 30 | +To maximize your chances of a successful contribution: |
| 31 | + |
| 32 | +- **Keep changes focused.** Address only what the issue requires. Do not bundle |
| 33 | + unrelated changes together. |
| 34 | + |
| 35 | +- **Be patient.** Do not solicit maintainers for a review. |
| 36 | + |
| 37 | +- **Remember:** project maintainers have no interest in reviewing code |
| 38 | + generated by machines. |
| 39 | + |
| 40 | +- **Do not make structural changes** to the codebase such as adding type hints. |
| 41 | + |
| 42 | +## Ways to Contribute |
| 43 | + |
| 44 | +See https://dejacode.readthedocs.io/en/latest/contributing.html for more ways to |
| 45 | +contribute. |
0 commit comments