Skip to content

Commit a454fd9

Browse files
Creating contributing.md
1 parent a4a385a commit a454fd9

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# How to contribute
2+
3+
First off, thank you for taking the time to contribute!
4+
5+
## Basic idea
6+
7+
Source + Doc + Test = :heart_eyes:
8+
9+
Please send a [GitHub Pull Request to codonPython](https://github.com/codonlibrary/codonPython/pull/new/master) with a
10+
clear description of what you have done.
11+
We suggest you follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
12+
Please do not send us undocumented code as we might not accept it. Including tests to your pull request brings tears of joy to our eyes.
13+
14+
The easier it is for us to review a pull request, the faster we will merge it.
15+
16+
## Coding conventions
17+
18+
Start reading our code and you will get an idea of it:
19+
20+
* We use [PEP8](https://www.python.org/dev/peps/pep-0008/).
21+
* We use docstrings and we try to (loosely) follow [`numpy`'s docstring standards](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard).
22+
* This is open source software. Consider the people who will read your code, and make it look nice for them.
23+
24+
Thank you,
25+
codonPeople

0 commit comments

Comments
 (0)