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 language on commit messages & notability #16789

Merged
merged 2 commits into from
Mar 2, 2024

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?

Updating the language to explain that our commit style is a requirement, instead of a preference. This will allow us to reduce the amount of autosquashed PR's.

Also putting an example for our notability check, which I haven't found documented anywhere. It seems to only be in:

if (metadata["forks_count"] < 30) && (metadata["subscribers_count"] < 30) &&
(metadata["stargazers_count"] < 75)
return "GitHub repository not notable enough (<30 forks, <30 watchers and <75 stars)"
end

Signed-off-by: Patrick Linnane <patrick@linnane.io>
@p-linnane p-linnane added the documentation Documentation changes label Mar 1, 2024
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Seems fine.

Why is autosquashing undesirable?

@p-linnane
Copy link
Member Author

It dispatches a replacement PR with a single squashed commit.

@ZhongRuoyu
Copy link
Member

Autosquashing is also less effective in guiding people to do it right next time, IMO.

Co-authored-by: Ruoyu Zhong <zhongruoyu@outlook.com>
@p-linnane p-linnane merged commit 0a3549b into master Mar 2, 2024
26 checks passed
@p-linnane p-linnane deleted the update-formulae-docs branch March 2, 2024 00:28
@github-actions github-actions bot added the outdated PR was locked due to age label Apr 3, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 3, 2024
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.

3 participants