Skip to content

Commit

Permalink
Add contributing page
Browse files Browse the repository at this point in the history
  • Loading branch information
OlivierBinette committed Jan 19, 2022
1 parent 961ba04 commit 6f9c102
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 20 deletions.
14 changes: 0 additions & 14 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,17 +110,3 @@ Tips
To run a subset of tests::

$ pytest tests.test_stringcompare


Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.
2 changes: 1 addition & 1 deletion README.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@
"source": [
"## Contribute\n",
"\n",
"**StringCompare** is currently in early development stage and contributions are welcome!"
"**StringCompare** is currently in early development stage and contributions are welcome! See the [contributing](https://stringcompare.readthedocs.io/en/latest/contributing.html) page for more information."
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,4 @@ Please report installation issues [here](https://github.com/OlivierBinette/Strin

## Contribute

**StringCompare** is currently in early development stage and contributions are welcome!
**StringCompare** is currently in early development stage and contributions are welcome! See the [contributing](https://stringcompare.readthedocs.io/en/latest/contributing.html) page for more information.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,4 @@ Please report installation issues `here <https://github.com/OlivierBinette/Strin
Contribute
----------

**StringCompare** is currently in early development stage and contributions are welcome!
**StringCompare** is currently in early development stage and contributions are welcome! See the `contributing <https://stringcompare.readthedocs.io/en/latest/contributing.html>`_ page for more information.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Links

readme
source/stringcompare
contributing
authors
history

Expand Down
4 changes: 1 addition & 3 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
StringCompare
stringcompare
=============

.. toctree::
:maxdepth: 4

setup
stringcompare
tests

0 comments on commit 6f9c102

Please sign in to comment.