Skip to content

Commit c26a467

Browse files
committed
add contributions policy CONTRIBUTING.md at the repo root
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent 90f4f5e commit c26a467

2 files changed

Lines changed: 54 additions & 4 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 ScanCode.io
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://scancodeio.readthedocs.io/en/latest/contributing.html for more ways to
45+
contribute.

README.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,14 @@ The ScanCode.io documentation also provides:
2727
If you have questions that are not covered by our documentation,
2828
please ask them in `Discussions <https://github.com/aboutcode-org/scancode.io/discussions>`_.
2929

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

3339
+------------+-------------------+
3440
| **Tests** | **Documentation** |
@@ -37,7 +43,7 @@ Build and tests status
3743
+------------+-------------------+
3844

3945
License
40-
-------
46+
=======
4147

4248
SPDX-License-Identifier: Apache-2.0
4349

@@ -58,7 +64,6 @@ ScanCode.io should be considered or used as legal advice. Consult an Attorney
5864
for any legal advice.
5965

6066

61-
6267
.. |ci-tests| image:: https://github.com/aboutcode-org/scancode.io/actions/workflows/run-unit-tests.yml/badge.svg?branch=main
6368
:target: https://github.com/aboutcode-org/scancode.io/actions/workflows/run-unit-tests.yml
6469
:alt: CI Tests Status
@@ -69,7 +74,7 @@ for any legal advice.
6974

7075

7176
Acknowledgements, Funding, Support and Sponsoring
72-
--------------------------------------------------------
77+
=================================================
7378

7479
This project is funded, supported and sponsored by:
7580

0 commit comments

Comments
 (0)