diff options
author | Seth Morton <seth.m.morton@gmail.com> | 2017-11-11 22:35:35 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-11-11 22:35:35 -0800 |
commit | 1a37d0ec62dd0949a24a4a5de41d91033c656a1f (patch) | |
tree | 1c00e9ea876269b5c2e00daf21ec745d13a4582a | |
parent | 3503e4ddcf6955cc405b925072cbe261f2640649 (diff) | |
download | natsort-1a37d0ec62dd0949a24a4a5de41d91033c656a1f.tar.gz |
Create CONTRIBUTING.md
-rw-r--r-- | CONTRIBUTING.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c3de3de --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +If you have an idea for how to improve `natsort`, please contribute! It can +be as simple as a bug fix or documentation update, or as complicated as a more +robust algorithm. + +I do not have strong opinions on how one should contribute, so +I have copy/pasted some text verbatim from the +[Contributor's Guide](http://docs.python-requests.org/en/latest/dev/contributing/) section of +[Kenneth Reitz's](http://docs.python-requests.org/en/latest/dev/contributing/) +excellent [requests](https://github.com/kennethreitz/requests) library in +lieu of coming up with my own. + +> ### Steps for Submitting Code + +> When contributing code, you'll want to follow this checklist: + +> - Fork the repository on GitHub. +> - Run the tests to confirm they all pass on your system. + If they don't, you'll need to investigate why they fail. + If you're unable to diagnose this yourself, + raise it as a bug report. +> - Write tests that demonstrate your bug or feature. Ensure that they fail. +> - Make your change. +> - Run the entire test suite again, confirming that all tests pass including the + ones you just added. +> - Send a GitHub Pull Request to the main repository's master branch. + GitHub Pull Requests are the expected method of code collaboration on this project. + +> ### Documentation Contributions +> Documentation improvements are always welcome! The documentation files live in the + docs/ directory of the codebase. They're written in + [reStructuredText](http://docutils.sourceforge.net/rst.html), and use + [Sphinx](http://sphinx-doc.org/index.html) + to generate the full suite of documentation. + +> When contributing documentation, please do your best to follow the style of the + documentation files. This means a soft-limit of 79 characters wide in your text + files and a semi-formal, yet friendly and approachable, prose style. + +> When presenting Python code, use single-quoted strings ('hello' instead of "hello"). |