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.

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

Fix angular allowed commit types #143

Closed

Conversation

satazor
Copy link
Contributor

@satazor satazor commented Nov 19, 2017

Motivation and Context

Allowed types were wrong according to https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits

Usage examples

Does not apply.

How Has This Been Tested?

Tested manually.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Couldn't run tests.. npm i && npm t fails with missing dependencies.

@e-cloud
Copy link

e-cloud commented Nov 20, 2017

your reference is angular.js not angular. see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type

@marionebl
Copy link
Contributor

marionebl commented Nov 20, 2017

Thanks for contributing!

Seems I pulled the trigger on changing to the Angular (vs Angular.js) conventions too early.

You PR reverts the breaking change introduced with the version 4.3.0to 5.0.0 update, see the BREAKING CHANGE section here:

https://github.com/marionebl/commitlint/releases/tag/v5.0.0

The reference commitlint now uses is here
https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type

If you want to continue using the previous commit types you can install @commitlint/config-angular@4 for now.

We probably should make the transition smoother by

  • republishing @commitlint/config-angular@4 as @commitlint/config-angular-legacy
  • Backporting the subject-tense change to legacy

What do you think?

Related

@marionebl
Copy link
Contributor

Follow up with Angular project angular/angular#20537

@satazor
Copy link
Contributor Author

satazor commented Nov 20, 2017

Yes probably the transition was too early, the conventional-changelog projects also need to adapt (suggested version, changelog generation, etc). Perhaps we should create an umbrella issue there to track progress to what needs to change.

Regarding the drop of chore, we kind of lost the type for maintenance operations which is unfortunate. I wonder what the reasoning was and what to use now.

About creating the legacy + backporting, I absolutely agree! Note that standard-version commits with the subject equal to the version so we must not break those use-cases.

@marionebl
Copy link
Contributor

I created this issue here to keep track of our progress:
https://github.com/marionebl/commitlint/issues/146

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants