Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README to mention breaking changes
Browse files Browse the repository at this point in the history
steveluscher committed Dec 3, 2023
1 parent 9cbaa65 commit 765adff
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -59,8 +59,9 @@ This is a release commit. Returning false.
Based on a commit's conventional commit message type:

1. If the type is `feat` `fix`, or `perf`, it's considered "meaningful"
2. If the type is `docs`, `refactor`, `style`, or `test`, it's ignored
3. If the message looks like `v1.2.3`, `chore: release 1.2.3`, or similar, it's considered a "release"
2. If the commit is marked as being a breaking change, either via a note or via an `!` appended to the type, it's considered "meaningful"
3. If the type is `docs`, `refactor`, `style`, or `test`, it's ignored
4. If the message looks like `v1.2.3`, `chore: release 1.2.3`, or similar, it's considered a "release"

See [`getCommitMeaning`](./src/getCommitMeaning.ts) for the exact logic used.

0 comments on commit 765adff

Please sign in to comment.