Skip to content

Commit 1729e2c

Browse files
authored
Merge pull request #2764 from embano1/issue-2763
2 parents 03f10a0 + 205c0e0 commit 1729e2c

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

.chglog/config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ options:
1515
- docs
1616
- examples
1717
- fix
18+
- api
1819
commit_groups:
1920
title_maps:
21+
api: 💫 API Changes
2022
govc: 💫 `govc` (CLI)
2123
vcsim: 💫 `vcsim` (Simulator)
2224
chore: 🧹 Chore

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,17 @@ $ git commit -s -m "govc: Add CLI command X" -m "Closes: #1234"
167167

168168
Currently the following prefixes are used:
169169

170+
- `api:` - Use for API-related changes
170171
- `govc:` - Use for changes to `govc` CLI
171172
- `vcsim:` - Use for changes to vCenter Simulator
172173
- `chore:` - Use for repository related activities
173174
- `fix:` - Use for bug fixes
174175
- `docs:` - Use for changes to the documentation
175176
- `examples:` - Use for changes to examples
176177

178+
If your contribution falls into multiple categories, e.g. `api` and `vcsim` it
179+
is recommended to break up your commits using distinct prefixes.
180+
177181
### Running CI Checks and Tests
178182
You can run both `make check` and `make test` from the top level of the
179183
repository.

0 commit comments

Comments
 (0)