Skip to content

Commit 31a62af

Browse files
committed
Update contributing guidelines
1 parent 724fa20 commit 31a62af

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,21 @@
33
Contributions to the RapidPro projects are highly appreciated!
44

55
We accept contributions in the form of:
6-
* bug reports
7-
* pull requests for code changes
8-
* documentation updates
6+
* Bug reports
7+
* Pull requests for code changes
8+
* Documentation updates
99

10-
All non-trivial pull requests, especially those with functional changes should first open a ticket to discuss approach and likelyhood of inclusion in the project.
10+
All non-trivial pull requests, especially those with functional changes should first open a ticket to discuss approach
11+
and likelihood of inclusion in the project.
1112

12-
Note that all pull requests must maintain 100% unit test coverage (without new no-covers) and pass all unit tests.
13+
Note that all pull requests must:
1314

14-
RapidPro is licensed under the AGPL-3.0 and your contributions will be licensed in the same way. Note that contributing does not change your rights to use your own Contributions for any other purpose.
15+
* Pass all unit tests
16+
* Maintain 100% unit test coverage (without new no-covers)
17+
* Pass the code quality checks (flake8 etc)
18+
19+
There is a script called `code_check.py` in the root of the repository which you can run to ensure that your PR will
20+
pass the checks configured in our CI.
21+
22+
RapidPro is licensed under the AGPL-3.0 and your contributions will be licensed in the same way. Note that contributing
23+
does not change your rights to use your own Contributions for any other purpose.

0 commit comments

Comments
 (0)