docs(CONTRIBUTING.md): Updated commit types. #15340
Conversation
| @@ -241,7 +241,9 @@ Must be one of the following: | |||
| semi-colons, etc) | |||
| * **refactor**: A code change that neither fixes a bug nor adds a feature | |||
| * **perf**: A code change that improves performance | |||
| * **test**: Adding missing tests | |||
| * **test**: Adding missing tests or correcting existing tests | |||
| * **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | |||
There was a problem hiding this comment.
Now build sounds almost identical to chore. If we decide to bring this over from Angular 2, we should update other types accordingly.
There was a problem hiding this comment.
You're right, I'll update chore
|
Are build and ci really necessary? |
|
AFAICT, the idea is to only have the same commit message guidelines across (angular) projects (see #15341). I am not sure I like the idea, though, because different projects (even ones as similar as Angular 1 vs 2) have different needs. In the name of consistency, we would either end up having a ton of types that are irrelevant to one project or being restricted to too generic types on another. |
|
I've added some more explanations to #15341. |
|
@gkalpak So... any update? Should I just leave the expanded "test" definition? |
|
Yes, please. We don't plan to use the additional types currently. |
Expanded "test" to also mean test fixes. Added a link to the help page about closing issues with commit messages in the section about the footer.
|
@Narretz Fixed. |
…g issues Expanded "test" to also mean test fixes. Added a link to the help page about closing issues with commit messages in the section about the footer. Closes angular#15340
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
docs update
What is the current behavior? (You can also link to an open issue here)
The commit types went out of sync with https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type
What prompted me to do this fix is that there wasn't 100% clear that test fixes (e.g. for flaky tests) should come in the "test" commits.
What is the new behavior (if this is a feature change)?
Commit types are the same as in Angular repo.
Does this PR introduce a breaking change?
No.
Please check if the PR fulfills these requirements
Other information:
Expanded "test" to also mean test fixes, added "build" and "ci".
This is to mirror the documentation in Angular (without JS) repo.