Release Software package
-
Define the release number (first major release could be 1.0.0) (at the moment we use semantic versioning (see pyproject.toml) -
Add a file "CHANGELOG.md" for example like in this sample project. This file is for documenting changes from one version to the next (useful in the future) -
Review documentation -
Mark the final version with a release Tag, according to the version (1.0.0) in GitLab -
Create a snapshot of your source code repository packaged as ZIP file -
Archive package at zenodo -
Add a section "Citation" in your README.md, which contains information how to cite and the Zenodo Doi (see example)
Edited by Nadezhda Sokolova