Skip to content

Improve documentation on how to bump a major version #196

@eedzjee

Description

@eedzjee

I was trying to bump a project's major version from 0.1.0 to 1.0.0, using the exclamation mark in the commit message:

feat!: this is a breaking change

Generating the changelog, it does add this beneath the heading "Breaking Changes", but the version only bumped to 0.2.0. After investigating this further, I found the comment in the code that says never to bump a the major version in a development release: https://github.com/qoomon/git-conventional-commits/blob/master/lib/semver.js#L4

I couldn't find anything about this in the README of this project. It might be a good idea to describe:

  • How to bump a major version (using the exclamation mark !)
  • Why it doesn't apply for development releases 0.x.x
  • And how to bump a development release to 1.0.0 (should this be done manually then?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions