Skip to content

Commit

Permalink
docs: Add type prefix link to CONTRIBUTING.md (#1007)
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md
  • Loading branch information
mpoke authored Jun 12, 2023
1 parent 1113ba4 commit 2b18b5e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,9 @@ Then:
4. Be sure to include a relevant changelog entry in the `Unreleased` section of `CHANGELOG.md` (see file for log format). The entry should be on top of all others changes in the section.

PRs must have a category prefix that is based on the type of changes being made (for example, `fix`, `feat`,
`refactor`, `docs`, and so on). The *type* must be included in the PR title as a prefix (for example,
`fix: <description>`). This convention ensures that all changes that are committed to the base branch follow the
`refactor`, `docs`, and so on). The [type](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
must be included in the PR title as a prefix (for example, `fix: <description>`).
This convention ensures that all changes that are committed to the base branch follow the
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
Additionally, **each PR should only address a single issue**.

Expand Down

0 comments on commit 2b18b5e

Please sign in to comment.