... | ... | @@ -95,7 +95,14 @@ The dependencies of miniff are captured in the following files. |
|
|
|
|
|
## Software versioning and Release management
|
|
|
|
|
|
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.
|
|
|
### Branching model
|
|
|
|
|
|
Currently, miniff is in development phase, the branching model is simplistic featuring only the master, feature branches and release branches.
|
|
|
|
|
|
* Master receives the changes for the next major/minor/patch release.
|
|
|
* Feature branches are used to work on new features and bug fixes. These are then merged to master upon completion.
|
|
|
* To mark specific points in the development history, tags are created along with a release note. This repository uses [Semantic versioning](https://semver.org/).
|
|
|
* A release branch will be created from master once the minimum required functionality for a public release is achieved in master.
|
|
|
|
|
|
### Workflow for software development and creation of a new release
|
|
|
|
... | ... | @@ -114,7 +121,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. This repository uses [Semantic versioning](https://semver.org/). 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. 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.
|
... | ... | |