openstack
/
deb-python-pint
Code Issues Proposed changes

Modified the contributing docs to reflect the new guidelines

This commit is contained in:
Hernan Grecco 2017-04-02 00:59:22 -03:00
parent cfb0d2e39b
commit 76dae1075b
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/contributing.rst
View File

@ -5,23 +5,30 @@ Contributing to Pint
You can contribute in different ways:
Report issues
-------------
You can report any issues with the package, the documentation to the Pint `issue tracker`_. Also feel free to submit feature requests, comments or questions.
You can report any issues with the package, the documentation to the Pint `issue tracker`_.
Also feel free to submit feature requests, comments or questions.
Contribute code
---------------
To contribute fixes, code or documentation to Pint, send us a patch, or fork Pint in github_ and submit the changes using a pull request.
To contribute fixes, code or documentation to Pint, fork Pint in github_ and submit
the changes using a pull request against the **master** branch.
If you are contributing **documentation** or **bug fixes**, do it based on the **master** branch.
- If you are fixing a bug, add a test to test_issues.py
Also add "Close #<bug number> as described in the `github docs`_.
- If you are submitting new code, add tests and documentation.
If you are contributing **new features** or code that changes the behaviour, do it based the **develop** branch.
Pint uses `bors-ng` as a merge bot and therefore every PR is tested before merging.
In any case, feel free to use the `issue tracker`_ to discuss ideas for new features or improvements.
.. _github: http://github.com/hgrecco/pint
.. _`issue tracker`: https://github.com/hgrecco/pint/issues
.. _`bors-ng`: https://github.com/bors-ng/bors-ng
.. _`github docs`: https://help.github.com/articles/closing-issues-via-commit-messages/