diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..02a8c26 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# How to contribute + +Development of nbstripout happens on +[GitHub](https://github.com/kynan/nbstripout) - +[bug reports](https://github.com/kynan/nbstripout/issues) and +[pull requests](https://github.com/kynan/nbstripout/pulls) welcome! + +# Releasing a new version + +To simplify updating the version number consistently across different files and +creating the appropriate annotated tag, we use +[bump-my-version](https://github.com/callowayproject/bump-my-version). For a new +patch release, run + + bump-my-version bump patch + +and for a minor release, run + + bump-my-version bump minor + +Remember to also push the release tag with `git push --tags`. + +Use [twine](https://twine.readthedocs.io/en/latest/#using-twine) to upload the +new release to PyPI: + + python -m build + twine check dist/nbstripout-0.6.2* + twine upload -r testpypi dist/nbstripout-0.6.2* + twine upload dist/nbstripout-0.6.2* diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 35b51ba..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,28 +0,0 @@ -How to contribute -================= - -Development of nbstripout happens on GitHub_ - `bug reports`_ and `pull -requests`_ welcome! - -Releasing a new version ------------------------ - -To simplify updating the version number consistently across different files -and creating the appropriate annotated tag, we use bump-my-version_. For a new -patch release, run :: - - bump-my-version bump patch - -and for a minor release :: - - bump-my-version bump minor - -Remember to also push the release tag with ``git push --tags``. - -Use twine_ to upload the new release to PyPI. - -.. _GitHub: https://github.com/kynan/nbstripout -.. _bug reports: https://github.com/kynan/nbstripout/issues -.. _pull requests: https://github.com/kynan/nbstripout/pulls -.. _bump-my-version: https://github.com/callowayproject/bump-my-version -.. _twine: https://twine.readthedocs.io/en/latest/#using-twine diff --git a/setup.cfg b/setup.cfg index 6e84ef8..5210535 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,6 +5,8 @@ tag = True tag_name = {new_version} tag_message = v{new_version} +[bumpversion:file:CONTRIBUTING.md] + [bumpversion:file:README.rst] search = rev: {current_version} replace = rev: {new_version}