-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert contributing guidelines to Markdown
- Loading branch information
Showing
3 changed files
with
31 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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* |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters