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

audit: add "homebrew/core" for relevant checks #6903

Merged
merged 1 commit into from
Jan 8, 2020
Merged

audit: add "homebrew/core" for relevant checks #6903

merged 1 commit into from
Jan 8, 2020

Conversation

jonchang
Copy link
Contributor

@jonchang jonchang commented Jan 8, 2020

  • 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 tests with your changes locally?

This should help contributors and maintainers of third-party taps to more clearly see which audits are specific to Homebrew-core. This will also be a prelude to including more core checks by default.

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.

Good idea. What do you think about using homebrew-core, Homebrew/core or Homebrew/homebrew-core instead?

@jonchang
Copy link
Contributor Author

jonchang commented Jan 8, 2020

Good idea. What do you think about using homebrew-core, Homebrew/core or Homebrew/homebrew-core instead?

I considered this (mainly Homebrew/core or Homebrew-core as it is closest to our usual style) but audits tend to be quite terse and economial. I'm open to changing this though.

@MikeMcQuaid
Copy link
Member

Another option would be core tap. I'm fine with this being merged as-is, though, up to you!

@jonchang
Copy link
Contributor Author

jonchang commented Jan 8, 2020

Here are the current references to "core" in audits and custom rubocops:

dev-cmd/audit.rb:353:problem "Formula name conflicts with existing core formula."
dev-cmd/audit.rb:954:problem "`env :std` in `core` formulae is deprecated" if line.include?("env :std")
rubocops/lines.rb:204:problem "Don't use #{check.source}; Homebrew/core only supports macOS"
rubocops/urls.rb:238:"Homebrew/homebrew-core is source-only."

@jonchang
Copy link
Contributor Author

jonchang commented Jan 8, 2020

I've changed this to homebrew/core throughout in line with our prose guidelines. Since I consider audits to be user-facing this should conform to the guidelines and be as clear as possible without introducing new jargon to new contributors.

@jonchang jonchang changed the title audit: add "core" wording for applicable checks audit: add "homebrew/core" for relevant checks Jan 8, 2020
@jonchang
Copy link
Contributor Author

jonchang commented Jan 8, 2020

Tests are green; merging. Thanks for the quick review @MikeMcQuaid!

@jonchang jonchang merged commit bcb8f4d into Homebrew:master Jan 8, 2020
@jonchang jonchang deleted the audit-core-wording branch January 8, 2020 20:53
@lock lock bot added the outdated PR was locked due to age label Feb 8, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Feb 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants