diff options
| author | Jeff Widman <jeff@jeffwidman.com> | 2017-07-23 23:23:03 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-07-23 23:23:03 -0600 |
| commit | 8ba0713e8ce5ccfe58e861d11033aefaa3128d39 (patch) | |
| tree | e9811d37fc8e17b706aced37a58301176e9b2fa8 | |
| parent | 83b9f94e32594516a65cd90fcf4fc16a02156467 (diff) | |
| download | kazoo-jeffwidman-fix-contributing-docs.tar.gz | |
docs: minor tweaks to contributing.mdjeffwidman-fix-contributing-docs
Fix readability, tense, grammar, etc.
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 133e03a..883aec8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ IRC in the ## Development -If you want to work on the code and sent us a +If you want to work on the code and send us a [pull request](https://help.github.com/articles/using-pull-requests), first fork the repository on github to your own account. Then clone your new repository and run the build scripts: @@ -27,8 +27,8 @@ your new repository and run the build scripts: You need to have some supported version of Python installed and have it available as `python` in your shell. To run Zookeeper you also -need a Java runtime (JRE or JDK) version 6 or 7. To run tests, you -need to have the tox, Python testing tool, to be installed in your shell. +need a Java runtime (JRE or JDK) version 6, 7 or 8. To run tests, you +need to have `tox`, the Python testing tool, installed in your shell. You can run all the tests by calling: @@ -64,7 +64,7 @@ you can and under what conditions you saw the issue. ## Adding Recipes New recipes are welcome, however they should include the status/maintainer -RST information so its clear who is maintaining the recipe. This does mean +RST information so its clear who is maintaining the recipe. This means that if you submit a recipe for inclusion with Kazoo, you should be ready to support/maintain it, and address bugs that may be found. @@ -133,9 +133,9 @@ In order to maintain a reference to the context of the commit, add `closes #<issue_number>` if it closes a related issue or `issue #<issue_number>` if it's a partial fix. -You can also write a detailed description of the commit: Just as in the +You can also write a detailed description of the commit. Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor -"changes" It should include the motivation for the change and contrast this with +"changes". Please include the motivation for the change and contrast this with previous behavior. ### Footer |