From 1301cc4aef7661a6f6bbead1d89e829a8047fecd Mon Sep 17 00:00:00 2001 From: Andrew Hobson <21983+ahobson@users.noreply.github.com> Date: Tue, 28 Jul 2020 11:46:33 -0400 Subject: [PATCH] docs: Even more info and emphasis on conventional commits (#350) --- docs/contributing.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/contributing.md b/docs/contributing.md index df3a770123..0bf448c241 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -63,7 +63,12 @@ Because this project exports a library that will be used by other projects, it i - For an optimal developer experience, it's recommended that you configure your editor to run linting & formatting inline. - These checks will also be run on all files in CI, and must pass before the branch can be merged - [`standard-version`](https://github.com/conventional-changelog/standard-version) is used during releases to auto-generate version numbers and changelog based on PR title. - - The version number is determined based on conventional commits - **[fix]** indicates a bug fix, **[feat]** indicates a minor bump. **[!]** or [BREAKING CHANGES] indicates a major bump. Be sure to use the correct spec. + - The version number is determined based on conventional commits - + **[fix]** indicates a bug fix, **[feat]** indicates a minor bump. + **[!]** or [BREAKING CHANGES] indicates a major bump. Other + possibilities include **build**, **ci**, **chore**, **docs**, + **perf**, **refactor**, **revert**, **style**, **test**. It is + *strongly* recommended you familiarize yourself with [conventional commits](https://www.conventionalcommits.org). - The **[WIP]** prefix can be used to indicate a pull request is still work in progress. In this case, the PR title is not validated and the pull request lint check remains pending. - The project is configured to only allow [squash & merge](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#squash-and-merge-your-pull-request-commits) PR commits. - [dangerjs](https://github.com/danger/danger-js) is used to enforce several pull request standards, including: