From 2e47df3436af8cb0e3cc65b193a32a02a48e784a Mon Sep 17 00:00:00 2001 From: Ondrej Nosek Date: Nov 12 2018 09:42:29 +0000 Subject: Add contributing guide Signed-off-by: Ondrej Nosek --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e7e2a03 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +We love seeing Pull Request from anyone. + +For bigger or controversial changes, consider first discussing it via issue or +any other method with the maintainers of this repository. Otherwise there's a +risk they might disagree with it and you could spend time on it in vain. Or you +can just open a Pull Request and keep the discussion there. +All code should work well with Python 3 and also be compatible with Python 2.6 +and 2.7. + + +## Sign Off + +All commits must be signed-off on. Please use `git commit -s` to do that. This +serves as a confirmation that you have the right to submit your changes. See +[Developer Certificate of Origin][0] for details. + +[0]: https://developercertificate.org/ + + +## Other tips + +You can increase the chance of your PR being merged by: + +* having good test coverage +* writing documentation +* following PEP 8 for code formatting +* writing [a good commit message][1] + +[1]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html diff --git a/MANIFEST.in b/MANIFEST.in index 9043293..59d571a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,6 +3,7 @@ include COPYING-koji include LGPL include CHANGELOG.rst include README.rst +include CONTRIBUTING.md include bin/rpkg recursive-include tests * recursive-include etc *