mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
Review some docs
- Most of these were fine still, apart from: - FAQ: `hub` is less maintained than `gh`. - Brew-Maintainer-Guide: link to GitHub docs on commit signing via GPG or SSH. - Interesting-Taps-and-Forks: remove outdated information about `homebrew/core` being in `Library/Taps`. - New-Maintainer-Checklist: remove outdated information about the `@members` team.
This commit is contained in:
Issy Long
parent
c62fcdfb20
commit
8f75f66d01
@ -3,7 +3,7 @@ logo: /assets/img/brewtestbot.png
|
||||
image: /assets/img/brewtestbot.png
|
||||
redirect_from:
|
||||
- /Brew-Test-Bot
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# BrewTestBot
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Creating a Homebrew Issue
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# FAQ (Frequently Asked Questions)
|
||||
@ -158,10 +158,9 @@ Ensure you have a [local copy of `homebrew/core`](#can-i-edit-formulae-myself),
|
||||
|
||||
```sh
|
||||
brew update
|
||||
brew install hub
|
||||
brew install gh
|
||||
cd "$(brew --repository homebrew/core)"
|
||||
hub fetch github_username
|
||||
hub pr checkout pull_request_number
|
||||
gh pr checkout pull_request_number
|
||||
```
|
||||
|
||||
## Why was a formula deleted or disabled?
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Homebrew/brew Maintainer Guide
|
||||
@ -15,7 +15,7 @@ PRs must meet the following conditions to be merged:
|
||||
- Have at least one maintainer approval.
|
||||
- Have passing CI (continuous integration). This is a _mandatory_ step. PRs with failing CI should _never_ be merged. See the [CI](#ci) section below for more information about `Homebrew/brew` CI.
|
||||
|
||||
If possible, PRs should also have GPG-signed commits (see the private `ops` repository for instructions on setting this up).
|
||||
If possible, PRs should also have [signed commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
|
||||
|
||||
### Automatic approvals
|
||||
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Interesting Taps and Forks
|
||||
|
||||
A [tap](Taps.md) is Homebrew-speak for a Git repository containing additional formulae.
|
||||
|
||||
Homebrew has the capability to add (and remove) multiple taps to your local installation with the `brew tap` and `brew untap` commands; run `man brew` in your terminal for usage information. The main repository at <https://github.com/Homebrew/homebrew-core>, often called `homebrew/core`, is always built-in.
|
||||
Homebrew has the capability to add (and remove) multiple taps to your local installation with the `brew tap` and `brew untap` commands; run `man brew` in your terminal for usage information.
|
||||
|
||||
Your taps are Git repositories located at `$(brew --repository)/Library/Taps`.
|
||||
Your taps are Git repositories located at `$(brew --repository)/Library/Taps`. As a normal user, you usually won't see `homebrew/core` here anymore and that's OK - [normal usage is via the JSON API](https://brew.sh/2023/02/16/homebrew-4.0.0/).
|
||||
|
||||
## Unsupported interesting taps
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Kickstarter Supporters
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Maintainer Guidelines
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Maintainers: Avoiding Burnout
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Migrating a Formula to a Tap
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# New Maintainer Checklist
|
||||
@ -107,15 +107,14 @@ The Project Leader, one other PLC member (ideally a maintainer) and one other TS
|
||||
- Make them owners on the [`machomebrew` private Slack](https://machomebrew.slack.com/admin)
|
||||
- Make them owners on the [`homebrew` private 1Password](https://homebrew.1password.com/people)
|
||||
|
||||
When they cease to be am owner, revoke or downgrade their access to all of the above.
|
||||
When they cease to be an owner, revoke or downgrade their access to all of the above.
|
||||
|
||||
## Members
|
||||
|
||||
People who are either not eligible or willing to be Homebrew maintainers but have shown continued involvement in the Homebrew community may be admitted by a majority vote of the [Project Leadership Committee](https://docs.brew.sh/Homebrew-Governance#4-project-leadership-committee) to join the Homebrew GitHub organisation as [members](https://docs.brew.sh/Homebrew-Governance#2-members).
|
||||
People who are either not eligible or willing to be Homebrew maintainers but have shown continued involvement in the Homebrew community may be admitted by a majority vote of the [Project Leadership Committee](https://docs.brew.sh/Homebrew-Governance#4-project-leadership-committee).
|
||||
|
||||
When admitted as members:
|
||||
|
||||
- Invite them to the [**@Homebrew/members** team](https://github.com/orgs/Homebrew/teams/members), to give them access to the private governance repository.
|
||||
- Invite them as a single-channel guest to the #members channel on the [`machomebrew` private Slack](https://machomebrew.slack.com/admin/invites) (and ensure they've read the [communication guidelines](Maintainer-Guidelines.md#communication)) and ask them to use their real name there (rather than a pseudonym they may use on e.g. GitHub).
|
||||
- Add them to the current year's membership list in the [governance archives](https://github.com/Homebrew/brew/tree/master/docs/governance).
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Prose Style Guidelines
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Querying `brew`
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Type Checking With Sorbet
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Updating Software in Homebrew
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
last_review_date: "2025-02-08"
|
||||
---
|
||||
|
||||
# Documentation
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user