Skip to content

Commit 5e4d75d

Browse files
committed
chore: add contributions policy
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent 595f1fe commit 5e4d75d

3 files changed

Lines changed: 51 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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.

CONTRIBUTING.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ The DejaCode documentation also provides:
2929
- how to customize your own workflows and reports.
3030
- guidelines for contributing to code development.
3131

32+
Contributing
33+
============
34+
35+
Thank you for your interest in contributing to AboutCode projects.
36+
Please `read the following guidelines carefully <https://github.com/aboutcode-org/dejacode/blob/main/CONTRIBUTING.md>`_ before getting started.
37+
3238
Build and tests status
3339
======================
3440

0 commit comments

Comments
 (0)