Skip to content

Commit e67d53f

Browse files
authored
docs: update contributing conventional commit message advice (#543)
1 parent 87ae6bd commit e67d53f

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,20 @@ circleci local execute orb-tools/review
7171

7272
### Commits
7373

74-
Use [simple semantic commit convention](https://github.com/bahmutov/simple-commit-message), just prefix your commits. For example:
74+
Refer to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and use this convention for the titles of Pull Requests and of commits. These are used when automatically generating a release note change log, shown in GitHub under [Releases](https://github.com/cypress-io/circleci-orb/releases).
7575

76-
```text
77-
major: breaking change
78-
minor: new feature added
79-
fix: a patch release
80-
```
76+
Commit types often used in this repo are:
77+
78+
- `feat:` A new feature
79+
- `fix:` A bug fix
80+
- `docs:` Documentation only changes
81+
- `chore:` Changes that have no user-facing impact
82+
- `test:` Add or change example tests
83+
- `ci:` Changes to CI configuration
84+
85+
For a breaking change that needs to be released with a new major version number of the Orb, mark it with the following tag in the body of the commit:
86+
87+
- `BREAKING CHANGE:`
8188

8289
### Releasing
8390

0 commit comments

Comments
 (0)