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.
-
Fork codonPython on GitHub.
-
Write your documented function and tests (:heart_eyes:) on a new branch, coding in line with our coding conventions.
-
Submit a pull request to codonPython with a clear description of what you have done.
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.
Start reading our code to get a feel for it:
- We use PEP8. Autoformatters for PEP8, for instance autopep8, can easily ensure compliance.
- We use docstrings and we try to (loosely) follow
numpy's docstring standards. - This is open source software. Consider the people who will read your code, and make it look nice for them.
🥂 Thank you! Team codon