Skip to content

Commit

Permalink
update README with checklist how to create a release
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippRue committed Nov 21, 2024
1 parent 07fcc3d commit 335aa03
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,19 @@ $ reentry scan -r aiida

# Usage and Documentation

* see http://aiida-kkr.readthedocs.io for user's guide and API reference.
* see http://aiida-kkr.readthedocs.io for user's and developer's guides and API reference
* check out http://judft.de and https://jukkr.fz-juelich.de for information of the KKR codes used by the plugin

# Contributing

Thank you for your interest in contributing to aiida-kkr.
Check out our [contributing guide](CONTRIBUTING.md) for some information.

# Releasing new versions

To create a new release follow these steps:
- finish your development and merge it into the `develop` branch
- update documentation
- update / fix tests
- bump version numbers (in files `aiida_kkr/__init__.py`, `pyproject.toml`, `.bumpversion.cfg`)
- merge changes from `develop` back into `master` and create a tag for the new version number (this triggers publication to pypi)

0 comments on commit 335aa03

Please sign in to comment.