- 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
- We prefer discussions so put those first.
- Clarify that pull requests are preferred to issues.
- Ask people to avoid opening both an issue and a pull request.
- Ask people to describe the problem and the fix in the pull request.
- Improve formatting.
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).
- Note issues may be closed without comment if sufficient information is
not provided.
- Deprecate Homebrew/brew-evolution, note new feature request flow
- Note some issues should be created on Homebrew/brew
To avoid extra work on the part of contributors and maintainers, this
adds a step to the explanation of how to contribute a fix to a formula,
showing how to check if someone else has already done so, even if it
has not yet finished being tested, reviewed, and released.
ClosesHomebrew/homebrew#48879.
Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Remove duplication, link to the API documentation more often,
tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s
and `@adamv`'s significant past contributions to Homebrew, delete some
outdated or unneeded documentation, add some missing `Formula` API.
entries and simplify/improve `CONTRIBUTING.md`.
ClosesHomebrew/homebrew#46179.
ClosesHomebrew/homebrew#46618.
Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Mike McQuaid