2017-02-03 10:04:57 +00:00
|
|
|
============
|
|
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
Contributions are welcome, and they are greatly appreciated! Every
|
|
|
|
|
little bit helps, and credit will always be given.
|
|
|
|
|
|
|
|
|
|
You can contribute in many ways:
|
|
|
|
|
|
|
|
|
|
Types of Contributions
|
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
|
|
Report Bugs
|
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Report bugs at https://github.com/JamesRamm/longclaw/issues.
|
|
|
|
|
|
|
|
|
|
If you are reporting a bug, please include:
|
|
|
|
|
|
|
|
|
|
* Your operating system name and version.
|
|
|
|
|
* Any details about your local setup that might be helpful in troubleshooting.
|
|
|
|
|
* Detailed steps to reproduce the bug.
|
|
|
|
|
|
|
|
|
|
Fix Bugs
|
|
|
|
|
~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Look through the GitHub issues for bugs. Anything tagged with "bug"
|
|
|
|
|
is open to whoever wants to implement it.
|
|
|
|
|
|
|
|
|
|
Implement Features
|
|
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
2017-02-12 21:48:41 +00:00
|
|
|
Look through the GitHub issues for features. Anything tagged with "enhancement"
|
2017-02-03 10:04:57 +00:00
|
|
|
is open to whoever wants to implement it.
|
|
|
|
|
|
|
|
|
|
Write Documentation
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
2017-02-12 21:48:41 +00:00
|
|
|
Longclaw could always use more documentation, whether as part of the
|
2017-02-03 10:04:57 +00:00
|
|
|
official longclaw 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/JamesRamm/longclaw/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 :)
|
|
|
|
|
|
|
|
|
|
Pull Request Guidelines
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
Before you submit a pull request, check that it meets these guidelines:
|
|
|
|
|
|
2017-02-12 21:48:41 +00:00
|
|
|
1. If the pull request adds functionality, the docs should be updated. Put
|
2017-02-03 10:04:57 +00:00
|
|
|
your new functionality into a function with a docstring, and add the
|
|
|
|
|
feature to the list in README.rst.
|
2017-02-12 21:48:41 +00:00
|
|
|
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4, 3.5 and for PyPy. Check
|
2017-02-03 10:04:57 +00:00
|
|
|
https://travis-ci.org/JamesRamm/longclaw/pull_requests
|
|
|
|
|
and make sure that the tests pass for all supported Python versions.
|
|
|
|
|
|
