Skip to content

Commit fc37713

Browse files
committed
fix: move to own page
1 parent 9a0375c commit fc37713

4 files changed

Lines changed: 48 additions & 41 deletions

File tree

content/about/ai_policy/_index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
+++
2+
title = "AI Policy"
3+
+++
4+
5+
6+
# scverse AI Policy
7+
8+
## Overview
9+
10+
scverse encourages its users to get involved with the development process, and if a user wishes to write code AI-assisted, that is also great!
11+
We encourage our users to do what is comfortable for them.
12+
However, since AI-assisted coding has led many open source projects to experience a massive increase in low-quality code submissions, we want to clarify our position in this document.
13+
14+
## Submitting AI-generated code
15+
16+
Once you have written that code, and you would like to contribute it to scanpy, squidpy, anndata etc., a human must review it.
17+
Our job is thus not only to secure the project (i.e., prevent bitcoin mining or other malicious code), but also to make sure it is maintainable in the longer term i.e., do we understand what is written and do we think it will be easy for others to understand should any of us be replaced or leave?
18+
AI often writes bloated and overly verbose comments, code, and tests.
19+
We try to ensure that every line of code has meaning and is necessary, and with AI-generated code, that is less often the case.
20+
When we look at a line of code two years down the line, it helps greatly if that line has clear context, semantically-meaningful variable names, and is concise.
21+
22+
Time is always a limited resource.
23+
Every hour we spend reviewing submitted code, we are not writing code ourselves.
24+
Therefore, we request that users be respectful of our time and ask themselves, "Would you want to review this PR?"
25+
Generally, whether AI touched the PR or not, it should present your best attempt to improve a publicly shared resource with clean, thoughtful code and concise and accurate PR descriptions.
26+
If you are unsure about something, that’s fine – help us clean up code that you don’t fully understand by drawing our attention to it with a review or code comment, and clearly mark which parts of your PR comments are just speculation or AI output.
27+
We are also mindful that coders come to our projects at all levels, and we hope that, in the process of our review, you will learn our best practices.
28+
From our side, you can expect us to be patient as you learn.
29+
However, this process fundamentally does not take place when you feed an LLM our hand-crafted PR reviews.
30+
As a general rule of thumb, it should not take a human longer to review the code than it does for you to write it.
31+
32+
You are responsible for the code you submit. This also includes the licensing of the submitted code.
33+
34+
## Repeated submission of low-quality code
35+
36+
You might say that a user can submit bad code repeatedly without an LLM, which is true.
37+
Indeed, if you were to submit a PR every 5 minutes that added “sadlkjfalsdjkfhasf” to all of our docs, that would also be bad.
38+
But an LLM can submit a PR every 5 minutes that looks reasonable and thus isn't easy to detect as spam.
39+
As stated previously, we do not review code only to improve what makes it into our repo; we also review to improve your ability to code, if you may need that.
40+
41+
We thus reserve the right to call out any PR we believe violates this policy with a warning.
42+
43+
As the legal and practical ramifications of the to-date nascent application of generative AI in coding emerge, we reserve the right to update this document.

content/about/code_of_conduct/_index.md

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -35,44 +35,4 @@ The group is making decisions independently from the project, PyData, NumFOCUS o
3535

3636
You can learn more about the current group members, as well as the reporting procedure on the [NumFOCUS Code of Conduct][] page.
3737

38-
[NumFOCUS Code of Conduct]: https://numfocus.org/code-of-conduct
39-
40-
41-
# scverse AI Policy
42-
43-
## Overview
44-
45-
scverse encourages its users to get involved with the development process, and if a user wishes to write code AI-assisted, that is also great!
46-
We encourage our users to do what is comfortable for them.
47-
However, since AI-assisted coding has led many open source projects to experience a massive increase in low-quality code submissions, we want to clarify our position in this document.
48-
49-
## Submitting AI-generated code
50-
51-
Once you have written that code, and you would like to contribute it to scanpy, squidpy, anndata etc., a human must review it.
52-
Our job is thus not only to secure the project (i.e., prevent bitcoin mining or other malicious code), but also to make sure it is maintainable in the longer term i.e., do we understand what is written and do we think it will be easy for others to understand should any of us be replaced or leave?
53-
AI often writes bloated and overly verbose comments, code, and tests.
54-
We try to ensure that every line of code has meaning and is necessary, and with AI-generated code, that is less often the case.
55-
When we look at a line of code two years down the line, it helps greatly if that line has clear context, semantically-meaningful variable names, and is concise.
56-
57-
Time is always a limited resource.
58-
Every hour we spend reviewing submitted code, we are not writing code ourselves.
59-
Therefore, we request that users be respectful of our time and ask themselves, "Would you want to review this PR?"
60-
Generally, whether AI touched the PR or not, it should present your best attempt to improve a publicly shared resource with clean, thoughtful code and concise and accurate PR descriptions.
61-
If you are unsure about something, that’s fine – help us clean up code that you don’t fully understand by drawing our attention to it with a review or code comment, and clearly mark which parts of your PR comments are just speculation or AI output.
62-
We are also mindful that coders come to our projects at all levels, and we hope that, in the process of our review, you will learn our best practices.
63-
From our side, you can expect us to be patient as you learn.
64-
However, this process fundamentally does not take place when you feed an LLM our hand-crafted PR reviews.
65-
As a general rule of thumb, it should not take a human longer to review the code than it does for you to write it.
66-
67-
You are responsible for the code you submit. This also includes the licensing of the submitted code.
68-
69-
## Repeated submission of low-quality code
70-
71-
You might say that a user can submit bad code repeatedly without an LLM, which is true.
72-
Indeed, if you were to submit a PR every 5 minutes that added “sadlkjfalsdjkfhasf” to all of our docs, that would also be bad.
73-
But an LLM can submit a PR every 5 minutes that looks reasonable and thus isn't easy to detect as spam.
74-
As stated previously, we do not review code only to improve what makes it into our repo; we also review to improve your ability to code, if you may need that.
75-
76-
We thus reserve the right to call out any PR we believe violates this policy with a warning.
77-
78-
As the legal and practical ramifications of the to-date nascent application of generative AI in coding emerge, we reserve the right to update this document.
38+
[NumFOCUS Code of Conduct]: https://numfocus.org/code-of-conduct

layouts/partials/footer.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ <h5>Governance</h5>
1818
<ul class="list-unstyled">
1919
<li><a href="/about/mission/">Mission statement</a></li>
2020
<li><a href="/about/code_of_conduct">Code of conduct</a></li>
21+
<li><a href="/about/ai_policy">AI Policy</a></li>
2122
<li><a href="/about/roles">Roles</a></li>
2223
</ul>
2324
</div>

layouts/partials/header.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,9 @@
103103
<li>
104104
<a class="dropdown-item" href="/about/code_of_conduct">Code of Conduct</a>
105105
</li>
106+
<li>
107+
<a class="dropdown-item" href="/about/ai_policy">AI Policy</a>
108+
</li>
106109
<li>
107110
<a class="dropdown-item" href="/design">Media kit</a>
108111
</li>

0 commit comments

Comments
 (0)