A small cleanup of contribution guide.
# Contributing
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
You can contribute in many ways:
@@ -19,8 +19,8 @@ If you are reporting a bug, please include:
### Fix Bugs
-Look through the GitHub issues for bugs. Anything tagged with "bug"
-and "help wanted" is open to whoever wants to implement it.
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
### Implement Features
@@ -29,20 +29,21 @@ and "help wanted" is open to whoever wants to implement it.
### Write Documentation
-parglare could always use more documentation, whether as part of the
-official parglare docs, in docstrings, or even on the web in blog posts,
-articles, and such.
+parglare could always use more documentation, whether as part of the official
+parglare docs, in docstrings, or even on the web in blog posts, articles, and
+such.
### Submit Feedback
-The best way to send feedback is to file an issue at https://github.com/igordejanovic/parglare/issues.
+The best way to send feedback is to file an issue at
+https://github.com/igordejanovic/parglare/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
-- Remember that this is a volunteer-driven project, and that contributions
- are welcome :)
+- Remember that this is a volunteer-driven project, and that contributions are
+ welcome :)
## Get Started!
@@ -92,12 +93,10 @@ Ready to contribute? Here's how to set up `parglare` for local development.
Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated. Put
- your new functionality into a function with a docstring, and add the
- feature to the list in README.rst.
-3. The pull request should work for Python 2.7, 3.3-3.6, and for
- PyPy. Check https://travis-ci.org/igordejanovic/parglare/pull_requests and
- make sure that the tests pass for all supported Python versions.
+2. If the pull request adds/changes functionality, the docs should be updated.
+3. The pull request should work for Python 2.7, 3.4-3.7. Check
+ https://travis-ci.org/igordejanovic/parglare/pull_requests and make sure that
+ the tests pass for all supported Python versions.
## Tips
