Skip to content

Commit

Permalink
docs: clarify use of conventional commit types (MINOR) (#8082)
Browse files Browse the repository at this point in the history
  • Loading branch information
vcrfxia authored Aug 31, 2021
1 parent 66b311d commit d0e2ea7
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,14 +191,22 @@ commit messages should be of the form:

[optional footer]

where the `type` is one of
where the `type` is one of the following, and determines whether or not the commit will appear in
the auto-generated changelog for releases. Commit types that do appear in changelogs are:
* "fix": for bug fixes
* "feat": for new features
* "refactor": for refactors
* "test": for test-only changes
* "docs": for docs-only changes
* "perf": for performance enhancements
* "revert": for reverting other changes
* "perf", "style", "build", "ci", or "chore": as described in the [Angular specification][https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type] for Conventional Commits.

Commit types that do not appear in changelogs include:
* "docs": for docs-only changes
* "test": for test-only changes
* "refactor": for refactors
* "style": for stylistic-only changes
* "build": for build-related changes
* "chore": for automated changes, as well as other changes not relevant for users.
This can include changes that don't fall cleanly into any of the other categories above such as
PRs that contain progress towards an incomplete feature.

The (optional) scope is a noun describing the section of the codebase affected by the change.
Examples that could make sense for ksqlDB include "parser", "analyzer", "rest server", "testing tool",
Expand Down

0 comments on commit d0e2ea7

Please sign in to comment.