Skip to content

Commit a8ed845

Browse files
committed
More minor edits
1 parent 77071ed commit a8ed845

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

llvm/docs/AIToolPolicy.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,18 @@ fully accountable for their contributions.**
99
treated as a suggestion, not as final code or text. It is your responsibility
1010
to review, test, and understand everything you submit. Submitting unverified or
1111
low-quality machine-generated content (sometimes called "[AI
12-
slop](https://simonwillison.net/2024/May/8/slop/)") creates an
13-
unfair review burden on the community and is not an acceptable contribution.
14-
Contributors should review and understand their own submissions before asking
15-
the community to review their code.
12+
slop][ai-slop]") creates an unfair review burden on the community and is not
13+
an acceptable contribution. Contributors should review and understand their own
14+
submissions before asking the community to review their code.
1615

1716
* **Start with small contributions:** Open source communities operate on trust
18-
and reputation. Reviewing large contributions is expensive. AI tools have a
19-
tendency to generate large contributions that are expensive to review. We
20-
encourage new contributors to keep their first contributions small until they
21-
build personal expertise and maintainer trust before taking on larger
22-
changes.
17+
and reputation. Reviewing large contributions is expensive, and AI tools tend
18+
to generate large contributions. We encourage new contributors to keep their
19+
first contributions small until they build personal expertise and maintainer
20+
trust before taking on larger changes.
2321

2422
* **Be transparent about your use of AI.** When a contribution has been
25-
significantly assisted by an AI tool, we encourage you to note this in your
23+
significantly generated by an AI tool, we encourage you to note this in your
2624
pull request description, commit message, or wherever authorship is normally
2725
indicated for the work. For instance, use a commit message trailer like
2826
Assisted-by: <name of code assistant>. This transparency helps the community
@@ -40,6 +38,8 @@ fully accountable for their contributions.**
4038
or not. The same principle of ownership applies to review comment
4139
contributions as it does to code contributions.
4240

41+
[ai-slop]: https://simonwillison.net/2024/May/8/slop/
42+
4343
This policy extends beyond code contributions and includes, but is not limited
4444
to, the following kinds of contributions:
4545

@@ -53,10 +53,10 @@ to, the following kinds of contributions:
5353

5454
Sending patches, PRs, RFCs, comments, etc to LLVM, is not free -- it takes a
5555
lot of maintainer time and energy to review those contributions! We see the act
56-
of sending low-quality unreviewed contributions to the LLVM project as
56+
of sending low-quality, un-self-reviewed contributions to the LLVM project as
5757
"extractive." It is an attempt to extract work from the LLVM project community
5858
in the form of review comments and mentorship, without the contributor putting
59-
in comensurate effort to make their work worth reviewing.
59+
in comensurate effort to make their contribution worth reviewing.
6060

6161
Our **golden rule** is that a contribution should be worth more to the project
6262
than the time it takes to review it. These ideas are captured by this quote
@@ -122,11 +122,13 @@ just like any other offending contribution.
122122
Here are some examples of contributions that demonstrate how to apply
123123
the principles of this policy:
124124

125-
- [This PR](https://github.com/llvm/llvm-project/pull/142869) contains a
126-
proof from Alive2, which is a strong signal of value and correctness.
127-
- This [generated
128-
documentation](https://discourse.llvm.org/t/searching-for-gsym-documentation/85185/2)
129-
was reviewed for correctness by a human before being posted.
125+
- [This PR][alive-pr] contains a proof from Alive2, which is a strong signal of
126+
value and correctness.
127+
- This [generated documentation][gsym-docs] was reviewed for correctness by a
128+
human before being posted.
129+
130+
[alive-pr]: https://github.com/llvm/llvm-project/pull/142869
131+
[gsym-docs]: https://discourse.llvm.org/t/searching-for-gsym-documentation/85185/2
130132

131133
## References
132134

0 commit comments

Comments
 (0)