20 Commits
Author SHA1 Message Date
Patrick Linnane 263f39e8a8 docs/Typechecking: note that some RBI files are handwritten
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2026-07-20 12:40:19 -07: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 013aaf58cd Remove RuboCop TODO suppressions
- Make local cops enforceable without broad TODO-style config skips.
- Rename `utils/gems` since Bundler reserves `gems.rb`.
- Keep RSpec helpers as `def` so Sorbet can see them.
- Explain why host OS checks stay legal in selected paths.
2026-05-22 14:40:12 +01:00
Mike McQuaid d661cffc1f Switch to using main as the default branch
Homebrew/brew has moved to a `main` default branch so we can more move
references from `master` to `main`.
2025-06-24 11:14:57 +01:00
Mike McQuaid dc71b7c8f6 Cleanup extend/ directory usage.
- move some things out of `extend` that don't really fit there e.g.
  `Module`s that are included but not doing any
  overriding/monkeypatching
- move some code into `extend/os` to fix all remaining
  `rubocop:todo Homebrew/MoveToExtendOS`s
- remove some unneeded `bundle` skipper code that doesn't really make
  sense given our current bottling strategy
- extract some `Pathname` extensions to `extend/pathname` for separate
  files
- move a `ENV` `Kernel` extension into `kernel.rb`
- `odeprecate` a seemingly unused backwards compatibility method
- move `readline_nonblock` from a monkeypatch to a
  `ReadlineNonblock.read` method as its only used in one place
- fix up a link in documentation
2025-06-09 19:06:16 +01:00
Eric Knibbe 2457fb123f docs/Typechecking review 2025-05-22 22:54:51 -04: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
Douglas Eichelberger ced4a3a91f Migrate Parlour extensions to Tapioca compilers 2024-10-14 19:50:09 -07:00
Bo Anderson 7117233e5f docs/Typechecking: update to latest code standards 2024-08-20 15:55:57 +01:00
Issy Long 6485324b18 Fix Sorbet/ group offenses in docs example code
- T::Sig hasn't been needed in every file for a long time.
2024-01-24 00:01:41 +00:00
Eric Knibbe 9372edf38f docs: re-case titles 2023-09-11 02:26:37 -04:00
Douglas Eichelberger f3d397a12d Update docs 2023-04-24 19:13:25 -07:00
EricFromCanada d615899ca9 Contributors docs: content & formatting updates
Update How-To-Open-a-Homebrew-Pull-Request.md

Update Acceptable-Formulae.md

Update Acceptable-Casks.md

Update License-Guidelines.md

Update Versions.md

Update Versions.md

Update Deprecating-Disabling-and-Removing-Formulae.md

Update Node-for-Formula-Authors.md

Update Python-for-Formula-Authors.md

Update Brew-Livecheck.md

Update Migrating-A-Formula-To-A-Tap.md

Update Rename-A-Formula.md

Update How-to-Create-and-Maintain-a-Tap.md

Update Brew-Test-Bot.md

Update Typechecking.md
2022-11-16 09:03:12 -05:00
EricFromCanada 034bf72235 Contributors docs: adjust line breaks 2022-11-16 09:03:12 -05:00
Markus Reiter 0e9b664d85 Update type checking documentation. 2020-12-13 03:39:15 +01:00
Issy Long e54980efd8 docs/typechecking: Titlecase the word "With"
- I don't necessarily agree with this, but it's AP style that words with
  four or more letters should start with a capital when in titles.
2020-10-21 21:10:51 +01:00
70548b8417 docs/typechecking: --quiet is a brew typecheck flag
Co-authored-by: Max Eisner <4730112+max-ae@users.noreply.github.com>
2020-10-17 22:02:25 +01:00
Issy Long 4e9773a650 docs/typechecking: Remove mentions of sorbet/files.yaml
- The `sorbet/files.yaml` file was removed in 4382ee9d14 in favour of more obvious individual type sigils in all files.
2020-10-17 21:35:28 +01:00
vidusheeamoli cba751a343 docs: add sorbet documentation
(cherry picked from commit 022571489a0f94ed54a0908167b553592cfe3277)
2020-08-21 21:22:39 +05:30