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

Integrate the commit message checker github action #13

Open
SanketDG opened this issue Jul 24, 2020 · 8 comments
Open

Integrate the commit message checker github action #13

SanketDG opened this issue Jul 24, 2020 · 8 comments
Assignees

Comments

@SanketDG
Copy link

The Portal project recently integrated commitlint to check for incorrect commit messages.

Can we integrate this for other projects?

@isabelcosta
Copy link
Member

yesss! I mean, how does this work?
Does this avoid a squash and merge with the wrong commit message? What is the workflow here? @SanketDG

@SanketDG
Copy link
Author

@isabelcosta Well, it just parses the commit message for a set of rules and then throws an error for the failed github action! (like tests have failed)

Sample: anitab-org/portal#566

@19-pragya
Copy link

can i work on this??

@SanketDG
Copy link
Author

Sure @19-pragya, should I assign you?

@19-pragya
Copy link

Yes please

@SanketDG
Copy link
Author

Let me know if you need any help.

@19-pragya
Copy link

actually, i am very new to this..
can you please explain waht exactly i have to to??
@SanketDG

@SanketDG
Copy link
Author

@19-pragya

Most projects at Anita-B have a Commit Message Style Guide, which is adhered by all developers when updating or creating commits for a PR. This is Portal's.

This was mostly checked by each and every PR reviewer manually, which is not the most effecient way to do it. So, why not let computers do what they are good what?

anitab-org/portal#607 introduced commitlint to automatically do this, so that reviewers don't have to check for each commit. Here's an example (if you scroll down you will see the commit message check failing) Here's the list of steps that one needs to do here:

  • Find a project under Anita-B that has a commit message style guide
  • Configure commitlint to use the set of rules as specified by the style guide
  • Open a PR!

This is not a beginner or first timer issue, but feel free to ask for help on here or Zulip if you choose to do this!

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

No branches or pull requests

3 participants