Skip to content

Commit

Permalink
Merge pull request #19265 from Homebrew/review-some-docs
Browse files Browse the repository at this point in the history
Review some docs
  • Loading branch information
issyl0 authored Feb 8, 2025
2 parents a0be99a + 8f75f66 commit f9b33d7
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/BrewTestBot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Creating-a-Homebrew-Issue.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Creating a Homebrew Issue
Expand Down
7 changes: 3 additions & 4 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# FAQ (Frequently Asked Questions)
Expand Down Expand Up @@ -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?
Expand Down
4 changes: 2 additions & 2 deletions docs/Homebrew-brew-Maintainer-Guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Homebrew/brew Maintainer Guide
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/Interesting-Taps-and-Forks.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Kickstarter-Supporters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Kickstarter Supporters
Expand Down
2 changes: 1 addition & 1 deletion docs/Maintainer-Guidelines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Maintainer Guidelines
Expand Down
2 changes: 1 addition & 1 deletion docs/Maintainers-Avoiding-Burnout.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Maintainers: Avoiding Burnout
Expand Down
2 changes: 1 addition & 1 deletion docs/Migrating-A-Formula-To-A-Tap.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Migrating a Formula to a Tap
Expand Down
7 changes: 3 additions & 4 deletions docs/New-Maintainer-Checklist.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# New Maintainer Checklist
Expand Down Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/Prose-Style-Guidelines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Prose Style Guidelines
Expand Down
2 changes: 1 addition & 1 deletion docs/Querying-Brew.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Querying `brew`
Expand Down
2 changes: 1 addition & 1 deletion docs/Typechecking.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Type Checking With Sorbet
Expand Down
2 changes: 1 addition & 1 deletion docs/Updating-Software-in-Homebrew.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Updating Software in Homebrew
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_review_date: "1970-01-01"
last_review_date: "2025-02-08"
---

# Documentation
Expand Down

0 comments on commit f9b33d7

Please sign in to comment.