|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -Thanks for getting involved, we really appreciate the help! Before you get going please have a read of the below... |
| 3 | +Thanks for getting involved, we really appreciate the help! |
4 | 4 |
|
5 | 5 | ## Commit Guidelines |
6 | 6 |
|
7 | | -Please structure your commit messages going by the [AngularJS commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines), also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog). You can install [commitizen](https://github.com/commitizen/cz-cli) to help, just follow their default setup instructions. |
| 7 | +Please structure your commit messages going by the [AngularJS commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines), also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog). |
| 8 | + |
| 9 | +We're using [commitlint](https://github.com/marionebl/commitlint) to help enforce these guidelines, you can install [commitizen](https://github.com/commitizen/cz-cli) to help, just follow their default setup instructions. |
8 | 10 |
|
9 | 11 | Examples: |
10 | 12 |
|
11 | | -| Commit Message | Version Change | |
12 | | -| ------------------------------------------------------------------------------------------------------------------- | -------------- | |
13 | | -| feat(Card): A new feature | **Minor** | |
14 | | -| fix(Button): A bug fix | **Patch** | |
15 | | -| docs(Header): Documentation only changes | None | |
16 | | -| style(Nav): Changes that do not affect the meaning of the code (white-space, for matting, missing semi-colons, etc) | None | |
17 | | -| refactor(Form): A code change that neither fixes a bug nor adds a feature | None | |
18 | | -| perf(): A code change that improves performance | None | |
19 | | -| test(): Adding missing tests or correcting existing tests | None | |
20 | | -| build(): Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | None | |
21 | | -| ci(): Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | None | |
22 | | -| chore(): Other changes that don't modify src or test files | None | |
23 | | -| revert(): Reverts a previous commit | None | |
24 | | - |
25 | | -##### Breaking changes |
| 13 | +| Commit Message | Version Change | |
| 14 | +| -------------------------------------------------------------------------------------------------------------------------- | -------------- | |
| 15 | +| feat(Card): A new feature | **Minor** | |
| 16 | +| fix(Button): A bug fix | **Patch** | |
| 17 | +| docs(Header): Documentation only changes | None | |
| 18 | +| style(Nav): Changes that do not affect the meaning of the code (white-space, for matting, missing semi-colons, etc) | None | |
| 19 | +| refactor(Form): A code change that neither fixes a bug nor adds a feature | None | |
| 20 | +| perf(Alert): A code change that improves performance | None | |
| 21 | +| test(Dropdown): Adding missing tests or correcting existing tests | None | |
| 22 | +| build(webpack): Changes that affect the build system or external dependencies (example scopes: webpack, greenkeeper,, npm) | None | |
| 23 | +| ci(buddy): Changes to our CI configuration files and scripts (example scopes: buddy, semantic-release) | None | |
| 24 | +| chore(package): Other changes that don't modify src or test files | None | |
| 25 | +| revert(#123): Reverts a previous commit | None | |
| 26 | + |
| 27 | +##### Breaking changes / Major Version |
26 | 28 |
|
27 | 29 | If your change breaks anything a new major version should be released. |
28 | 30 | To do this your commit body needs to include 'BREAKING CHANGE:'. If you are using commitizen you will be asked about breaking changes during your commit. |
|
0 commit comments