Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Even more info and emphasis on conventional commits #350

Merged
merged 1 commit into from
Jul 28, 2020
Merged

docs: Even more info and emphasis on conventional commits #350

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down