Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Adopt Conventional Commits #487

Merged
merged 2 commits into from
Aug 28, 2017
Merged

Adopt Conventional Commits #487

merged 2 commits into from
Aug 28, 2017

Conversation

ChristianMurphy
Copy link
Contributor

@ChristianMurphy ChristianMurphy commented Aug 6, 2017

Hey @UW-Madison-DoIT/uportal-application-framework-committers 👋

I've been thinking lately about how to manage releases, while looking at how other open source projects have been approaching the problem, I came across conventional commits. 👀

The goal the conventional commits standard is to simplify management of semantic versioning. Metadata provided by commit messages is used to guide releases as MAJOR, MINOR, or PATCH.

It seems like the standard could be a good fit with the existing processes and culture at Madison. ⭐
I'd be interested to hear your thoughts on whether adopting conventional commits could be a good idea. 💭

Technical changes in this PR:

  • Add commitlint to check commit messages
  • Add git hook from husky to trigger commitlint on every change
  • Add commitlint config angular, which checks conventional commits, and comes with preset types to use with conventional commits.
  • Add commitizen, which provides a CLI for generating conventional commits

commitizen-demo-2

Related to uPortal-Attic/uportal-home/pull/666


Contributor License Agreement adherence:

commitlint automatically checks that commit messages follow the conventional commit standard.
commitizen provides a cli for generating conventional commits.
@apetro
Copy link
Contributor

apetro commented Aug 10, 2017

Backlogged MUMMNG-3765 to track in MyUW Scrum allocating MyUW team attention to engaging with this proposal. Should hit the top of the queue no later than end of August.

@vertein
Copy link
Contributor

vertein commented Aug 28, 2017

Just like uPortal-Attic/uportal-home#666, this has my 👍 too.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants