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

Enforce semantic commit messages #118

Closed
hwgilbert16 opened this issue Mar 8, 2024 · 6 comments · Fixed by #119
Closed

Enforce semantic commit messages #118

hwgilbert16 opened this issue Mar 8, 2024 · 6 comments · Fixed by #119

Comments

@hwgilbert16
Copy link
Owner

Using Husky and commitlint, commit messages should be enforced using a semantic style:

<type>(<scope>): <subject>, not this: (<scope>) <type>: <subject>

@Jayanth-Parthsarathy
Copy link
Contributor

Hey there @hwgilbert16. I would love to work on this can I get this assigned please?

@hwgilbert16
Copy link
Owner Author

Hey there @hwgilbert16. I would love to work on this can I get this assigned please?

Yes - I've assigned you this issue.

@Jayanth-Parthsarathy
Copy link
Contributor

Jayanth-Parthsarathy commented Mar 8, 2024

@hwgilbert16. To be more clear the commit should be of the format (api + docs) feat: add correct response bodies for folder endpoints right as seen from the previous commits. Please correct me if I am wrong.

@WhyNeet
Copy link
Collaborator

WhyNeet commented Mar 8, 2024

Hey @Jayanth-Parthsarathy. The commit message format is described in Angular repository. Commitlint has a prebuilt config for conventional commit messages: @commitlint/config-conventional

@Jayanth-Parthsarathy
Copy link
Contributor

Hey @Jayanth-Parthsarathy. The commit message format is described in Angular repository. Commitlint has a prebuilt config for conventional commit messages: @commitlint/config-conventional

Thank you for your input! I thought I had to add some custom rule to parse the commit message in addition to @commitlint/config-conventional. Thanks for the heads up 👍🏽

@Jayanth-Parthsarathy
Copy link
Contributor

Hey @hwgilbert16. Please have a look and let me know if any changes are to be made.

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