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

docs: update commit style guidelines #16031

Merged
merged 1 commit into from Sep 26, 2023

Conversation

p-linnane
Copy link
Member

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

We ask people to check the commit style guidelines when submitting PR's, but we never updated them to state we prefer one squashed commit now. Otherwise the autosquash workflow dispatches replacement PR's, which wastes CI time.

@p-linnane p-linnane added the documentation Documentation changes label Sep 25, 2023
Copy link
Contributor

@apainintheneck apainintheneck left a comment

Choose a reason for hiding this comment

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

LGTM! It might be good to mention the why too but maybe that's too much information to include in the formula cookbook.

@MikeMcQuaid MikeMcQuaid merged commit a8a1afc into Homebrew:master Sep 26, 2023
25 checks passed
@MikeMcQuaid
Copy link
Member

Thanks again @p-linnane!

@p-linnane p-linnane deleted the update-commit-guidelines branch September 26, 2023 13:34
@EricFromCanada
Copy link
Member

Does the line "Do not squash commits after updating a pull request" from https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#style-guide still apply?

@p-linnane
Copy link
Member Author

Does the line "Do not squash commits after updating a pull request" from https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#style-guide still apply?

This doesn't apply to homebrew-cask, just homebrew-core.

@github-actions github-actions bot added the outdated PR was locked due to age label Oct 27, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation changes outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants