... | ... | @@ -121,15 +121,19 @@ 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.
|
|
|
* 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.
|
|
|
|
|
|
|
|
|
* Bump up the version number in setup.py
|
|
|
|
|
|
|
|
|
* Ideally, make a merge request towards master when your changes are complete, i.e., all the required changes for a particular new major, minor or patch version that you intend to create are present in your feature branch. This ensure that master doesn't have a half baked new functionality/feature/bugfix at any point in time.
|
|
|
|
|
|
|
|
|
* After the feature branch is merged into master, create a tag on the master to mark the new major/minor/patch version and push the tag to the repository.
|
|
|
```
|
|
|
git tag -a x.y.z -m "release note"
|
... | ... | |