From 9cf24929a97e68b52bd1e4b4cdd303c98aed73eb Mon Sep 17 00:00:00 2001 From: Murdo Moyse Date: Thu, 8 Aug 2019 13:48:06 +0100 Subject: [PATCH 1/2] More contributing guidance --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad9da2b..4e0fbd6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,10 @@ First off, thank you for taking the time to contribute! ## Basic idea +* Fork codonPython on GitHub. +* Make a new branch for your contribution on that fork. +* Submit a pull request to codonPython. + Source + Doc + Test = :heart_eyes: Please send a [GitHub Pull Request to codonPython](https://github.com/codonlibrary/codonPython/pull/new/master) with a From 63f5d5a2b978d58593e7857f5ea64700c7400975 Mon Sep 17 00:00:00 2001 From: Murdo Moyse Date: Thu, 8 Aug 2019 13:51:19 +0100 Subject: [PATCH 2/2] Editing --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e0fbd6..f284d8e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,13 +13,13 @@ Source + Doc + Test = :heart_eyes: Please send a [GitHub Pull Request to codonPython](https://github.com/codonlibrary/codonPython/pull/new/master) with a clear description of what you have done. We suggest you follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit). -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. +Please do not send us undocumented code as we might not accept it. Including tests in your pull request will bring tears of joy to our eyes. The easier it is for us to review a pull request, the faster we will merge it. ## Coding conventions -Start reading our code and you will get an idea of it: +Start reading our code to get an idea of it: * We use [PEP8](https://www.python.org/dev/peps/pep-0008/). * We use docstrings and we try to (loosely) follow [`numpy`'s docstring standards](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard).