opensource/fd
3
0
Fork 0
mirror of https://github.com/sharkdp/fd.git synced 2026-08-29 02:32:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add PR Expectations

Browse Source 
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.
This commit is contained in:
Thayne McCombs
2026-04-14 00:52:15 -06:00
parent a665a3bba9
commit 749ea313f6
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+13
View File
@@ -10,6 +10,19 @@ We welcome any form of contribution:
**Note**: Before you take the time to open a pull request, please open a ticket first. This will
give us the chance to discuss any potential changes first.
## Pull Request Expectations
1. Your contribution should be high quality, and best effort. In particular, please don't make a Pull Request
that was created using generative AI unless you have reviewed it yourself and understand what it does, and be
able to meaningfully answer questions and make changes to it as needed.
2. Your code should successfully compile and pass tests before publishing a Pull Request. It's understandable
if tests fail on one or two specific targets, but if the build doesn't pass for any targets, that is a signal
that the PR is low effort.
3. It is your responsibility to ensure that the generated code does not violate any copyrights or patents. This is
true of all contributions, but is especially relevant when using an LLM that may be generating output that is
very similar or even identical to existing code with an incompatible license.
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.
## Add an entry to the changelog
If your contribution changes the behavior of `fd` (as opposed to a typo-fix