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

Add a check for the commit message format when one of the sources is modified #4888

Open
JohelEGP opened this issue Sep 9, 2021 · 6 comments

Comments

@JohelEGP
Copy link
Contributor

JohelEGP commented Sep 9, 2021

To avoid manual checks like #4886 (comment).

@tkoeppe
Copy link
Contributor

tkoeppe commented Sep 9, 2021

Hm, is that checkable?

@JohelEGP
Copy link
Contributor Author

JohelEGP commented Sep 9, 2021

At the very least, the first or at least one commit message in a PR can be checked to begin the regex ^[.+].

@tkoeppe
Copy link
Contributor

tkoeppe commented Sep 9, 2021

Which system is able to query and process the git metadata, though? GitHub Actions?

@tkoeppe
Copy link
Contributor

tkoeppe commented Sep 9, 2021

Also, I'm not sure we really should have a zero-tolerance check here; there are cases where that format isn't appropriate. It's just that most commits should follow that format.

@JohelEGP
Copy link
Contributor Author

JohelEGP commented Sep 9, 2021

Which system is able to query and process the git metadata, though? GitHub Actions?

I believe so.

Also, I'm not sure we really should have a zero-tolerance check here; there are cases where that format isn't appropriate. It's just that most commits should follow that format.

Perhaps a more appropriate solution would be to use templates as a reminder for this most-common case, and a link to the README for completeness. For this, the "Get involved:" should be a header so that it can be linked to.

@jensmaurer
Copy link
Member

@tkoeppe, there's always the chance to manually override a failed check and merge regardless. Personally, I think an automated check seems worthwhile.

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