Skip to content

Commit 749ea31

Browse files
committed
docs: Add PR Expectations
Add expectations for making pull requests to CONTRIBUTING.md My main objective is to try to discourage low-effort AI generated pull requests. But I realized several of the guidelines were actually more general, so made the section as a whole more general.
1 parent a665a3b commit 749ea31

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ We welcome any form of contribution:
1010
**Note**: Before you take the time to open a pull request, please open a ticket first. This will
1111
give us the chance to discuss any potential changes first.
1212

13+
## Pull Request Expectations
14+
15+
1. Your contribution should be high quality, and best effort. In particular, please don't make a Pull Request
16+
that was created using generative AI unless you have reviewed it yourself and understand what it does, and be
17+
able to meaningfully answer questions and make changes to it as needed.
18+
2. Your code should successfully compile and pass tests before publishing a Pull Request. It's understandable
19+
if tests fail on one or two specific targets, but if the build doesn't pass for any targets, that is a signal
20+
that the PR is low effort.
21+
3. It is your responsibility to ensure that the generated code does not violate any copyrights or patents. This is
22+
true of all contributions, but is especially relevant when using an LLM that may be generating output that is
23+
very similar or even identical to existing code with an incompatible license.
24+
4. If an AI coding assistant or other LLM tool was used, you must indicate that an AI tool was used, and to what extent it was used.
25+
1326
## Add an entry to the changelog
1427

1528
If your contribution changes the behavior of `fd` (as opposed to a typo-fix

0 commit comments

Comments
 (0)