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

Fail build if commit naming convention is not met #436

Closed
alenkacz opened this issue Jan 20, 2021 · 5 comments
Closed

Fail build if commit naming convention is not met #436

alenkacz opened this issue Jan 20, 2021 · 5 comments
Labels
area/build good first issue Good for newcomers kind/enhance New feature or request team/devprod display on zenhub workspace for devprod team

Comments

@alenkacz
Copy link
Contributor

alenkacz commented Jan 20, 2021

There's a convention for commit naming - all commits should be prefixed with component/sub-component name. It would be nice to have this convention enforced so that it's easy to follow for new contributors.

We could use pre-commit hook or at least start with a github action validating that.

JIRA Link: CORE-583

@alenkacz
Copy link
Contributor Author

@0xdiba any other ideas here? :)

@emaxerrno emaxerrno added area/build good first issue Good for newcomers kind/enhance New feature or request labels Jan 20, 2021
@dotnwat
Copy link
Member

dotnwat commented Jan 21, 2021

Is pre-commit hooks an opt-in sort of thing? I create many commits that do not follow this rule during the development process.

@alenkacz
Copy link
Contributor Author

hmm good point, that would probably not be a good idea. Maybe just something that's run in CI then? Found this, maybe we can reuse this or write something similar https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-rules.md

@dotnwat
Copy link
Member

dotnwat commented Feb 5, 2021

hmm good point, that would probably not be a good idea. Maybe just something that's run in CI then? Found this, maybe we can reuse this or write something similar https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-rules.md

yeh! good idea @alenkacz . i think we have at least a few unwritten style guidelines (e.g. prefix: subject is a good one) that would be easy enough to check in a github action, either enforcing a rule or maybe for some rules gently reminding about the guidelines but not blocking.

@ivotron ^ what do you think

@ivotron
Copy link
Member

ivotron commented Feb 5, 2021

commitlint seems really cool! I think we should adopt it. I'll look deeper into it

@emaxerrno emaxerrno added this to the v21.3.x milestone Feb 19, 2021
@ivotron ivotron added the team/devprod display on zenhub workspace for devprod team label May 5, 2022
@ivotron ivotron removed their assignment Aug 2, 2022
@ivotron ivotron removed this from the v21.3.x milestone Aug 2, 2022
@twmb twmb closed this as completed Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build good first issue Good for newcomers kind/enhance New feature or request team/devprod display on zenhub workspace for devprod team
Projects
None yet
Development

No branches or pull requests

5 participants