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

CONTRIBUTING.md: Add line about commit messages #75417

Merged
merged 1 commit into from
Apr 19, 2021

Conversation

cdayjr
Copy link
Contributor

@cdayjr cdayjr commented Apr 18, 2021

  • Have you followed the guidelines for contributing?
  • [N/A] Have you checked that there aren't other open pull requests for the same formula update/change?
  • [N/A] Have you built your formula locally with brew install --build-from-source <formula>, where <formula> is the name of the formula you're submitting?
  • [N/A] Is your test running fine brew test <formula>, where <formula> is the name of the formula you're submitting?
  • [N/A] Does your build pass brew audit --strict <formula> (after doing brew 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.

@cdayjr cdayjr requested a review from MikeMcQuaid as a code owner April 18, 2021 09:20
@BrewTestBot BrewTestBot added the automerge-skip `brew pr-automerge` will skip this pull request label Apr 18, 2021
dawidd6
dawidd6 previously approved these changes Apr 18, 2021
Copy link
Member

@carlocab carlocab left a 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.

CONTRIBUTING.md Show resolved Hide resolved
@carlocab carlocab added the CI-syntax-only Change only affects brew syntax, not the install. Only run syntax CI. label Apr 18, 2021
carlocab
carlocab previously approved these changes Apr 18, 2021
Copy link
Member

@carlocab carlocab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cdayjr!

@carlocab
Copy link
Member

Will leave this open for a bit longer to get more eyes on it.

nandahkrishna
nandahkrishna previously approved these changes Apr 18, 2021
Copy link
Member

@nandahkrishna nandahkrishna left a 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.

@cdayjr cdayjr dismissed stale reviews from nandahkrishna and carlocab via e1a612c April 18, 2021 20:56
nandahkrishna
nandahkrishna previously approved these changes Apr 18, 2021
Copy link
Member

@nandahkrishna nandahkrishna left a 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
Copy link
Member

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?

Copy link
Member

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.

@MikeMcQuaid
Copy link
Member

Cool, I don't feel strongly, I'll leave to another maintainer to merge this.

@carlocab
Copy link
Member

@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?

@nandahkrishna
Copy link
Member

I'm fine with the original one as well.

@cdayjr
Copy link
Contributor Author

cdayjr commented Apr 19, 2021

Thanks all. I have removed the additional commits from this branch.

Copy link
Member

@carlocab carlocab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @cdayjr!

@carlocab carlocab enabled auto-merge (squash) April 19, 2021 15:34
@carlocab carlocab merged commit 79200e7 into Homebrew:master Apr 19, 2021
@cdayjr cdayjr deleted the contributing-md branch April 19, 2021 15:36
@github-actions github-actions bot added the outdated PR was locked due to age label May 20, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
automerge-skip `brew pr-automerge` will skip this pull request CI-syntax-only Change only affects brew syntax, not the install. Only run syntax CI. outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants