Skip to content

Commit

Permalink
docs: adjust versioning documentation
Browse files Browse the repository at this point in the history
BREAKING CHANGE: Adding breaking change to correct the version bump which didn't happen when merging #285
  • Loading branch information
MRichards99 committed Nov 22, 2021
1 parent 5fd00c4 commit 44c48e8
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,10 +314,7 @@ fix: fix bug found with count endpoints #issue-number
feat: add endpoints for search API #issue-number
# Commit which introduces a breaking change for users
BREAKING CHANGE: change format of `config.json`, the previous version is no longer supported #issue-number
# You can also use `BREAKING CHANGE:` in the additional information if the commit also adds a new feature, like so:
feat: my new feature #issue-number
<commit-type>: change format of `config.json`, the previous version is no longer supported #issue-number
BREAKING CHANGE: this feature means X functionality has been removed
```
Expand Down

0 comments on commit 44c48e8

Please sign in to comment.