Commit Graph
62 Commits
Author SHA1 Message Date
Mike McQuaid 70b0685f27 Update package manager slogan 2026-07-26 19:48:28 +01:00
Patrick Linnane d81691b615 docs: update maintainer operations guides
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2026-07-20 11:47:25 -07:00
Mike McQuaid 2412d42198 Approve stale lead maintainer PRs
- Add scheduled approval for trusted stale lead maintainer PRs
- Move approval checks into a `utils/github` Ruby script
- Short-circuit API reads once approval is impossible
- Require stale PRs to be open 48 hours without review
- Permit recent approval evidence from fork PRs
- Refuse to auto-approve sensitive paths
- Use event type for branch push reports
- Document the supply-chain guardrails and maintainer behaviour
2026-06-22 09:20:47 +01:00
Mike McQuaid 9569699c92 Add Responsible AI Usage documentation
- explain the principles behind our AI/LLM usage rules for
  maintainers and contributors rather than just the requirements
- riff off Administrate's "AI at Administrate" guidance: human in
  the loop, trust appropriately, use AI to improve AI, try things
- cross-link from the index, `CONTRIBUTING` guide, pull request
  template, PR how-to, maintainer guidelines and new maintainer
  checklist so the guidance is discoverable where AI use comes up
2026-06-11 09:23:57 +01:00
Mike McQuaid 04b2b4a4b1 docs: clarify upstream expectations
- add a dedicated guide for upstream projects working with Homebrew
- link relevant maintainer and policy docs to the new guidance
- explain escalation and decision-making expectations more clearly
2026-04-26 12:39:01 +01:00
Issy Long 8f75f66d01 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.
2025-02-08 14:43:49 +00:00
Issy Long 31d7bcc583 Add a last_reviewed_date to docs metadata
- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
  documentation, so that we can periodically implement a review
  mechanism (GitHub Actions posts to Slack for a regular documentation
  outdatedness check?) to track how old docs are and ensure they're
  still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
  to the metadata of all docs with a date of earlier than Homebrew's
  inception because everything needs reviewing so that we start from a
  good base!
2025-02-03 11:56:07 +00:00
Mike McQuaid 9aaae260a9 docs/Maintainer-Guidelines: tweak auto-merging.
Now we require comments to be resolved: the flow is a bit nicer here.
2024-07-26 17:39:40 +01:00
Patrick Linnane 773dbfa92a docs: update for Homebrew/cask-fonts deprecation
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-16 09:21:14 -07:00
Patrick Linnane e4f7618545 docs: update for Homebrew/cask-versions deprecation
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-02 14:40:07 -07:00
fdcc2c7296 docs: clarify pull request review guidelines.
- Move the guidelines from Homebrew/brew Maintainer Guide to
  Maintainer Guidelines as they apply to all repositories.
- Clarify the guidelines to make it clear that the default option
  should be to approve a PR, with or without comments.
- Note in the New Maintainer Checklist that the most important task for
  maintainers is reviewing pull requests.

Co-authored-by: Issy Long <me@issyl0.co.uk>
Co-authored-by: Sam Ford <1584702+samford@users.noreply.github.com>
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2024-04-10 13:52:18 +01:00
Mike McQuaid ae94d9e28b docs: various tweaks.
Adjust various maintainer and contributor-focused documents after
recent maintainer conversations and generally anything I noticed was
wrong or outdated as I went through these.
2023-12-06 14:29:09 -05:00
Razvan Azamfirei 5192866abe homebrew-cask-drivers: deprecate official tap 2023-06-08 08:12:59 -04:00
EricFromCanada a329003e17 Maintainers docs: content & formatting updates 2022-12-06 12:52:03 -05:00
EricFromCanada 43070d73a1 Maintainers docs: adjust line breaks 2022-12-06 12:52:03 -05:00
Michka PopoffandMike McQuaid 1cc7ca33c0 update: migrate everyone from linuxbrew-core to homebrew-core
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2021-10-20 11:01:38 +01:00
Rylan Polster 52f4025c61 docs: rename core maintainer guide for consistency 2021-05-19 12:52:28 -04:00
Rylan PolsterandEric Knibbe de5fd4642d docs: update based on suggestions from code review
Co-Authored-By: Eric Knibbe <3324775+EricFromCanada@users.noreply.github.com>
2021-05-14 13:49:16 -04:00
Rylan Polster 04f5433dcc docs: update based on suggestions from code review 2021-05-13 20:14:28 -04:00
Rylan Polster 73ca9a0e05 docs: add cask cookbook link to maintainer guidlines 2021-05-13 02:51:15 -04:00
Rylan Polster ce2a942d67 docs: temporarily rename core maintainer guide 2021-05-13 02:34:31 -04:00
Rylan Polster e0230330d0 docs: add brew maintainer guide 2021-05-13 02:30:01 -04:00
Dustin Rodrigues 949e89f91e docs: remove recommended/optional from maintainer guidelines 2021-04-22 22:09:00 -04:00
6133c6602a docs: use and instead of &
Co-authored-by: Sam Ford <1584702+samford@users.noreply.github.com>
2020-12-31 10:44:00 -05:00
Rylan PolsterandSam Ford b605b3ebe5 docs: further clarify merging workflows
Co-Authored-By: Sam Ford <1584702+samford@users.noreply.github.com>
2020-12-30 21:12:45 -05:00
Rylan PolsterandSam Ford bca13a4926 docs: clarify GitHub merge workflow usage
Co-Authored-By: Sam Ford <1584702+samford@users.noreply.github.com>
2020-12-30 16:22:46 -05:00
Rylan Polster 07ffa7dda7 docs: clarify squash/merge vs rebase/merge 2020-12-29 13:02:14 -05:00
Dustin Rodrigues 1c925d52fe docs - remove Discourse from communication methods 2020-11-15 13:20:03 -05:00
Mike McQuaid 57e8f348f5 Maintainer-Guidelines: add homebrew-core 24h caveat. 2020-10-28 10:11:58 +00:00
Mike McQuaid 2e957b24b9 Maintainer-Guidelines: note refactoring PR review. 2020-10-26 12:46:10 +00:00
Mike McQuaid f64e1fcf8f Maintainer-Guidelines: give maintainers time to review enhancements.
Let's slow down a little on enhancement PRs to give other maintainers
time to give their feedback.

This is mostly self-directed criticism.
2020-10-26 12:07:31 +00:00
Claudia f4d81fee1c Add flowchart for managing pull requests
- Add flowchart for handling ready-to-merge pull requests

- Add diagram guidelines

Many thanks to Sean Molenaar for the idea and initial version of the
chart.

CC: Sean Molenaar <smillernl@me.com>
2020-09-06 14:54:28 +02:00
Mike McQuaid ac0665daff Refer to default branch in links with HEAD
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 11:38:40 +01:00
Issy Long 397f56446b docs/Maintainer-Guidelines: Reflect brew mirror now being automatic
- Thanks to #7709, we've saved some maintainer time from doing this
  manually.
- To check that it's working, search for "Mirrored <formula_name>" in the CI
  log output for the publish bottles action for relevant formulae like
  ImageMagick in the future.
2020-06-17 20:21:13 +01:00
Issy Long fdc1068071 docs/Maintainer-Guidelines: Document brew mirror
- I vaguely remembered that ImageMagick was a download we mirrored on
  BinTray and that doing so required some manual effort post-merge. I
  went looking for some docs to confirm that memory, but didn't find
  any.
2020-06-08 16:41:36 +01:00
Jonathan Chang cf63925005 docs: Update for new pr-* workflows 2020-04-11 20:06:31 +10:00
Mike McQuaid a84a20e97b .github/: defer to Homebrew/.github repo.
This allows maintaining more settings in one place.
2019-05-23 09:46:28 +02:00
Mike McQuaid aafcbc1153 Add/link Homebrew Governance document. 2019-02-15 10:54:30 +00:00
Mike McQuaid 1b609ceeb3 Update maintainer documentation.
- Fix Markdown format
- Note Linux in the mission statement
- Update the maintainer guidelines based on current state
- Loosen the new maintainer expectations
- Clarify what things the PLC should be added to
- Add documentation for making a new Homebrew release
2019-02-13 15:02:18 +00:00
516e2b41d5 Update docs/Maintainer-Guidelines.md
Co-Authored-By: MikeMcQuaid <mike@mikemcquaid.com>
2019-02-04 17:19:38 +01:00
Mike McQuaid 947b90961b Note leadership changes
Today the Homebrew maintainers elected a new PLC, TSC and project lead.
Documentation is to follow detailing exactly the responsibilities for
each of these roles but adjust these to reflect the current state until
that point.
2019-02-04 17:09:31 +01:00
Mike McQuaid cf391ef160 Maintainer-Guidelines: add sjackman CI test note. 2018-12-17 15:55:06 +00:00
Mike McQuaid 3245b91900 docs/Maintainer-Guidelines: don't merge failing tests. 2018-12-10 14:48:47 +00:00
Mike McQuaid 76016340cd docs/Maintainer-Guidelines: add mission. 2018-11-02 14:59:20 +00:00
Mike McQuaid 573da9002b docs/Maintainer-Guidelines: change lead maintainer date.
I'll step down on February 4th to better coincide with the Homebrew
maintainers in-person conference. This will make it easier to resolve
any logistical issues that arise.
2018-10-09 09:51:17 +01:00
EricFromCanada 31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
Mike McQuaid 54fe8e0ec0 docs: fix broken links. 2018-10-04 15:37:02 +01:00
Mike McQuaid a9d363fdfe docs/Maintainer-Guidelines: retire lead maintainer position in Febuary. 2018-09-12 09:16:34 +01:00
Mike McQuaid cc620dbecb docs/Maintainer-Guidelines: address more comments. 2018-09-09 12:08:54 +01:00
Mike McQuaid b919af43fb docs/Maintainer-Guidelines: clarify/fix wording. 2018-09-08 08:41:04 +01:00