Skip to content

Commit ff94cd6

Browse files
committed
Moved the considerations to be earlier in the page.
1 parent ef31ff8 commit ff94cd6

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

getting-started/generative-ai.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,24 @@ contribution is the responsibility of the contributor. We value good code, conci
99
and avoiding unneeded code churn. Discretion, good judgment, and critical thinking are the foundation of all good
1010
contributions, regardless of the tools used in their creation.
1111

12+
Considerations for success
13+
==========================
14+
15+
Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR.
16+
17+
We expect PR authors to be able to explain their proposed changes in their own words.
18+
19+
Disclosure of the use of AI tools in the PR description is appreciated, while not required. Be prepared to explain how
20+
the tool was used and what changes it made.
21+
22+
Whether you are using Generative AI or not, keep the following principles in mind for the quality
23+
of your contribution:
24+
25+
- Consider whether the change is necessary
26+
- Make minimal, focused changes
27+
- Follow existing coding style and patterns
28+
- Write tests that exercise the change
29+
1230
Acceptable uses
1331
===============
1432

@@ -28,21 +46,3 @@ If a contributor repeatedly opens unproductive issues or PRs, they may be blocke
2846

2947
Sometimes AI assisted tools make failing unit tests pass by altering or bypassing the tests rather than addressing the
3048
underlying problem in the code. Such changes do not represent a real fix and are not acceptable.
31-
32-
Considerations for success
33-
==========================
34-
35-
Authors must review the work done by AI tooling in detail to ensure it actually makes sense before proposing it as a PR.
36-
37-
We expect PR authors to be able to explain their proposed changes in their own words.
38-
39-
Disclosure of the use of AI tools in the PR description is appreciated, while not required. Be prepared to explain how
40-
the tool was used and what changes it made.
41-
42-
Whether you are using Generative AI or not, keep the following principles in mind for the quality
43-
of your contribution:
44-
45-
- Consider whether the change is necessary
46-
- Make minimal, focused changes
47-
- Follow existing coding style and patterns
48-
- Write tests that exercise the change

0 commit comments

Comments
 (0)