Skip to content

Commit

Permalink
Convert contributing guidelines to Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
kynan committed Feb 4, 2024
1 parent 7e51a0b commit c043497
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 28 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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*
28 changes: 0 additions & 28 deletions CONTRIBUTING.rst

This file was deleted.

2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit c043497

Please sign in to comment.