mirror of
https://github.com/Homebrew/brew.git
synced 2026-08-12 22:29:27 +04:00
Clarify contribution guidelines
- Require Hyperfine benchmarks for performance claims - Limit non-maintainers to one AI-assisted PR at a time
This commit is contained in:
@@ -5,12 +5,12 @@
|
||||
|
||||
- [ ] Have you followed the guidelines in our [Contributing](https://github.com/Homebrew/brew/blob/HEAD/CONTRIBUTING.md) document?
|
||||
- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/Homebrew/brew/pulls) for the same change?
|
||||
- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
|
||||
- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? Performance claims (e.g. "this is faster") must include [Hyperfine](https://github.com/sharkdp/hyperfine) benchmarks.
|
||||
- [ ] Have you written new tests (excluding integration tests) for your changes? [Here's an example](https://github.com/Homebrew/brew/blob/HEAD/Library/Homebrew/test/PATH_spec.rb).
|
||||
- [ ] Have you successfully run `brew lgtm` (style, typechecking and tests) with your changes locally?
|
||||
|
||||
-----
|
||||
|
||||
- [ ] AI was used to generate or assist with generating this PR. *Please specify below how you used AI to help you, and what steps you have taken to manually verify the changes*.
|
||||
- [ ] AI was used to generate or assist with generating this PR. *Please specify below how you used AI to help you, and what steps you have taken to manually verify the changes*. Non-maintainers may only have one AI-assisted/generated PR open at a time.
|
||||
|
||||
-----
|
||||
|
||||
@@ -20,6 +20,7 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c
|
||||
* Ideally, open a pull request to implement it, describing both the problem it solves for you and your proposed solution.
|
||||
* If not, open an issue with a detailed description of your proposed feature, the motivation for it and alternatives considered.
|
||||
* Please note we may close this issue or ask you to create a pull request if this is not something we see as sufficiently high priority.
|
||||
* Any pull request claiming performance improvements (e.g. "this is faster") must include [Hyperfine](https://github.com/sharkdp/hyperfine) benchmark results demonstrating the improvement.
|
||||
|
||||
### "Artificial Intelligence"/Large Language Model (AI/LLM) usage
|
||||
|
||||
@@ -28,6 +29,7 @@ We allow you to create issues and pull requests with AI/LLM with the following r
|
||||
* You must disclose in the initial issue or pull request that you used AI/LLM and what tool/model/etc. you used.
|
||||
* You must review all AI/LLM generated code, prose, etc. content before you ask anyone in Homebrew to review it for you.
|
||||
* You must be able to address all pull request review comments, manually if the AI/LLM cannot do so for you.
|
||||
* Unless you are a maintainer, you may only have one AI-assisted/generated pull request open at a time.
|
||||
* If you reach the point where you feel unwilling or unable to do the above, please close your issue or pull request.
|
||||
|
||||
Thanks!
|
||||
|
||||
Reference in New Issue
Block a user