diff options
author | Ionel Cristian Mărieș <contact@ionelmc.ro> | 2016-03-08 13:57:47 +0200 |
---|---|---|
committer | Ionel Cristian Mărieș <contact@ionelmc.ro> | 2016-03-08 13:57:47 +0200 |
commit | c5d3a2357a974d667df9e224af2c2e3460cb53a2 (patch) | |
tree | 8d0fd92001518cb9ade1ab5dda4eca51cd35af0f /CONTRIBUTING.rst | |
parent | cb7a3bd7629d3aeee9851f1249f156ebc14ab79c (diff) |
Upgrade skel. Add docs dir.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4eb5bdd..85e6472 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -30,14 +30,15 @@ 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 code contributions are welcome :) Development =========== To set up `python-tblib` for local development: -1. `Fork python-tblib on GitHub <https://github.com/ionelmc/python-tblib/fork>`_. +1. Fork `python-tblib <https://github.com/ionelmc/python-tblib>`_ + (look for the "Fork" button). 2. Clone your fork locally:: git clone git@github.com:your_name_here/python-tblib.git @@ -68,15 +69,15 @@ If you need some code review or feedback while you're developing the code just m For merging, you should: 1. Include passing tests (run ``tox``) [1]_. -2. Update documentation when there's new API, functionality etc. +2. Update documentation when there's new API, functionality etc. 3. Add a note to ``CHANGELOG.rst`` about the changes. 4. Add yourself to ``AUTHORS.rst``. -.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will +.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will `run the tests <https://travis-ci.org/ionelmc/python-tblib/pull_requests>`_ for each change you add in the pull request. - + It will be slower though ... - + Tips ---- @@ -86,4 +87,4 @@ To run a subset of tests:: To run all the test environments in *parallel* (you need to ``pip install detox``):: - detox
\ No newline at end of file + detox |