-
-
Notifications
You must be signed in to change notification settings - Fork 12.6k
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
CONTRIBUTING.md: Add line about commit messages #75417
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @cdayjr. One small suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @cdayjr!
Will leave this open for a bit longer to get more eyes on it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. Although there are some instructions right at the bottom (the point with run git commit ...
), having this at the top with a link to the Formula Cookbook section would definitely make it more noticeable and should hopefully translate into more contributors adhering to the guidelines.
Just a small suggestion (I don't feel too strongly about this): We may want to prefix the first sentence with If you are creating a pull request,
. I say this because right below the message, we have the To report a bug
section, and that doesn't require committing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
CONTRIBUTING.md
Outdated
@@ -2,6 +2,11 @@ | |||
|
|||
First time contributing to Homebrew? Read our [Code of Conduct](https://github.com/Homebrew/.github/blob/HEAD/CODE_OF_CONDUCT.md#code-of-conduct). | |||
|
|||
If you are creating a pull request, ensure your commits follow the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is mentioned in "To add a new formula" below and brew bump-formula-pr
will handle it for you too. Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still pull out my "please use homebrew/core style in your commit messages" saved reply at least once a day, so I think a lot of users still miss it.
I'm fine with making this less verbose (i.e. back to @cdayjr's original suggestion 😅) so easier to scan.
Cool, I don't feel strongly, I'll leave to another maintainer to merge this. |
@cdayjr I think I'm happy to go back to your original suggestion to keep things less verbose. Verbosity discourages contributors. Or at least, discourages contributors from reading the guidelines. Sorry for flip-flopping on this! Thoughts, @nandahkrishna? |
I'm fine with the original one as well. |
Thanks all. I have removed the additional commits from this branch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @cdayjr!
brew install --build-from-source <formula>
, where<formula>
is the name of the formula you're submitting?brew test <formula>
, where<formula>
is the name of the formula you're submitting?brew audit --strict <formula>
(after doingbrew install <formula>
)?I saw there was a bot check for the commit messages after I had already went through the checklist above and got my PR ready, I figure it'd make sense to add a line about the commit styles in the CONTRIBUTING.md guide.