From a4f1877085cdaf5e63a00d1ab07d3fbb8909ba58 Mon Sep 17 00:00:00 2001 From: Robert Jordens Date: Tue, 17 Apr 2018 12:12:40 +0200 Subject: [PATCH] CONTRIBUTING: add checklist for code contributions --- CONTRIBUTING.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 14cdaa256..65fe5d11f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -47,6 +47,30 @@ that the testsuite passes. Then prepare a pull request or send patches to the discussed. Expect your contribution to be held up to coding standards (e.g. use ``flake8`` to check yourself). +Checklist for Code Contributions +-------------------------------- + +- Test your changes or have someone test them. Mention what was tested and how. +- Use correct spelling and grammar. Use your code editor to help you with + syntax, spelling, and style +- Style: PEP-8 (``flake8``) +- Add, check docstrings and comments +- Split your contribution into logically separate changes (``git rebase + --interactive``). Merge (squash, fixup) commits that just fix previous commits + or amend them. Remove unintended changes. Clean up your commits. +- Check the copyright situation of your changes and sign off your patches + (``git commit --signoff``, see also below) +- Write meaningful commit messages containing the area of the change + and a concise description (50 characters or less) in the first line. + Describe everything else in the long explanation. +- Review each of your commits for the above items (``git show``) +- Update ``RELEASE_NOTES.md`` if there are noteworthy changes, especially if + there are changes to existing APIs +- Check, test, and update the documentation in `doc/` +- Check, test, and update the conda recipes in `conda/` +- Check, test, and update the unittests +- Close and/or update issues + Copyright and Sign-Off ----------------------