|
1 | 1 | # How to contribute |
2 | 2 |
|
3 | | -First off, thank you for taking the time to contribute! If you have a functionality that you would like to see in codon, we have a few guidelines about how to make sure your code is in line with our standards so we can merge your pull request quicker. |
| 3 | +First off, thank you for taking the time to contribute! If you have a functionality that you would like to see in codon, we have a few standards and guidelines so we can merge your pull request quicker. |
4 | 4 |
|
5 | 5 | ## Basic idea |
6 | 6 |
|
7 | 7 | 1. [Fork](https://help.github.com/en/articles/fork-a-repo) codonPython on GitHub. |
8 | 8 |
|
9 | | -2. Create your documented function and tests (:heart_eyes:) on a new branch on that fork, with code in line with our *coding conventions*. |
| 9 | +2. Write your documented function and tests (:heart_eyes:) on a new branch, coding in line with our **coding conventions**. |
10 | 10 |
|
11 | | -3. Submit a [GitHub Pull Request to codonPython](https://github.com/codonlibrary/codonPython/pull/new/master) with a clear description of what you have done. |
| 11 | +3. Submit a [GitHub Pull Request](https://github.com/codonlibrary/codonPython/pull/new/master) to codonPython with a clear description of what you have done. |
12 | 12 |
|
13 | | -We suggest you make sure all of your commits are atomic (one feature per commit). Please make sure that non-obvious lines of code are commented, and variable names are as clear as possible. Please do not send us undocumented code as we might not accept it. Including tests to your pull request will bring tears of joy to our eyes, and will also probably result in a faster merge. |
| 13 | +We suggest you make sure all of your commits are atomic (one feature per commit). Please make sure that non-obvious lines of code are commented, and variable names are as clear as possible. Please do not send us undocumented code as we will not accept it. Including tests to your pull request will bring tears of joy to our eyes, and will also probably result in a faster merge. |
14 | 14 |
|
15 | 15 | ## Coding conventions |
16 | 16 |
|
17 | | -Start reading our code and you will get an idea of it: |
| 17 | +Start reading our code to get a feel for it: |
18 | 18 |
|
19 | | -* We use [PEP8](https://www.python.org/dev/peps/pep-0008/). Autoformatters for PEP8, for instance [autopep8](https://pypi.org/project/autopep8/) can ensure compliance easily. |
| 19 | +* We use [PEP8](https://www.python.org/dev/peps/pep-0008/). Autoformatters for PEP8, for instance [autopep8](https://pypi.org/project/autopep8/), can easily ensure compliance. |
20 | 20 | * We use docstrings and we try to (loosely) follow [`numpy`'s docstring standards](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard). |
21 | 21 | * This is open source software. Consider the people who will read your code, and make it look nice for them. |
22 | 22 |
|
|
0 commit comments