Skip to content

Commit 46c9e29

Browse files
committed
Add contributing guide
1 parent 2154e0c commit 46c9e29

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
How to contribute
2+
=================
3+
4+
Development happens on GitHub_ - `bug reports`_ and `pull requests`_ welcome!
5+
6+
Releasing a new version
7+
-----------------------
8+
9+
To simplify updating the version number consistently across different files
10+
and creating the appropriate annotated tag, we use bump2version_. For a new
11+
patch release, run ::
12+
13+
bump2version patch
14+
15+
and for a minor release ::
16+
17+
bump2version minor
18+
19+
Remember to also push the release tag with ``git push --tags``.
20+
21+
Use twine_ to upload the new release to PyPI.
22+
23+
.. _GitHub: https://github.com/kynan/dokuwikixmlrpc
24+
.. _bug reports: https://github.com/kynan/dokuwikixmlrpc/issues
25+
.. _pull requests: https://github.com/kynan/dokuwikixmlrpc/pulls
26+
.. _bump2version: https://github.com/c4urself/bump2version
27+
.. _twine: https://twine.readthedocs.io/en/latest/#using-twine

0 commit comments

Comments
 (0)