... | ... | @@ -94,13 +94,10 @@ The dependencies of miniff are captured in the following files. |
|
|
|
|
|
|
|
|
## Software versioning and Release management
|
|
|
(Under construction ...)
|
|
|
|
|
|
Currently, miniff is in development phase. The master branch receives the changes for the next major/minor/patch release. To mark specific points in the development history, tags are created along with a release note. A release branch will be created from master once the required functionality is in master.
|
|
|
|
|
|
This repository uses [Semantic versioning](https://semver.org/).
|
|
|
|
|
|
Follow the below development workflow when adding new changes to miniff.
|
|
|
### Workflow for software development and creation of a new release
|
|
|
|
|
|
* Start with creating a new issue on the issue board for the changes you wish to add. This can be a new feature, enhancement or a bug fix.
|
|
|
|
... | ... | @@ -117,7 +114,7 @@ git checkout -b <feature-abc> master |
|
|
* pyproject.toml
|
|
|
* gitlab-ci.yml
|
|
|
|
|
|
* Update CHANGELOG.md describing your changes as per [keep a changelog](https://keepachangelog.com/en/1.0.0/) format and associate them with a version number. Determine the version number as per the below convention from semantic versioning.
|
|
|
* Update CHANGELOG.md describing your changes as per [keep a changelog](https://keepachangelog.com/en/1.0.0/) format and associate them with a version number. This repository uses [Semantic versioning](https://semver.org/). Determine the version number as per the below convention from semantic versioning.
|
|
|
* Bump up the patch version if you are making a bug fix/minor enhancement,
|
|
|
* Bump up the minor version if you are adding new feature, functionality that is backwards compatible.
|
|
|
* bump up the major version if you are making ground breaking backwards incompatible changes.
|
... | ... | @@ -135,5 +132,3 @@ git push origin x.y.z |
|
|
```
|
|
|
|
|
|
* Upload the new version to PyPI and Zenodo following the steps lised in the sections Packaging miniff and uploading to PyPI and software citation respectively. |
|
|
|
|
|
|