Skip to content

Commit a11e769

Browse files
stefanvlagruStefan van der Walt
authored
Restore wording of AI policy (#8123)
Co-authored-by: Lars Grüter <lagru@mailbox.org> Co-authored-by: Stefan van der Walt <github@mentat.za.net>
1 parent d00454c commit a11e769

2 files changed

Lines changed: 47 additions & 22 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,17 @@
1-
## Description
2-
31
<!--
4-
- Reference relevant issues or related pull requests with their URL / #<number>.
5-
- Use `pre-commit` to check and format code.
6-
-->
2+
Please see the Contribution Guide:
3+
https://scikit-image.org/docs/dev/development/contribute.html
4+
For newcomers: this document has a checklist of what we expect in a PR.
75

8-
## Checklist
9-
10-
<!-- Before pull requests can be merged, they should provide: -->
6+
Also please note our AI policy:
7+
https://scikit-image.org/docs/dev/development/contribute.html#ai-policy
8+
-->
119

12-
- A descriptive but concise pull request title
13-
- [Docstrings for all functions](https://github.com/numpy/numpydoc/blob/main/doc/example.py)
14-
- [Unit tests](https://scikit-image.org/docs/dev/development/contribute.html#testing)
15-
- A gallery example in `./doc/examples` for new features
16-
- [Contribution guide](https://scikit-image.org/docs/dev/development/contribute.html) is followed
10+
<!-- ... PR description goes here ... -->
1711

18-
## Release note
12+
### Release note (optional)
1913

20-
For maintainers and optionally contributors, please refer to the [instructions](https://scikit-image.org/docs/stable/development/contribute.html#documenting-changes) on how to document this PR for the release notes.
14+
<!-- See https://scikit-image.org/docs/stable/development/contribute.html#documenting-changes -->
2115

2216
```release-note
2317
...

‎CONTRIBUTING.rst‎

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,21 +85,28 @@ can be contributed to scikit-image.
8585
Please write `good commit messages
8686
<https://vxlabs.com/software-development-handbook/#good-commit-messages>`_.
8787

88-
3. To submit your contribution:
88+
* It is a good idea to read our :ref:`guidelines` at this point.
89+
While we don't require a contribution to meet every guideline from the
90+
start, they will come up during review.
8991

90-
* Push your changes back to your fork on GitHub:
92+
3. To submit your contribution:
9193

92-
::
94+
* Push your changes back to your fork on GitHub::
9395

9496
git push codemonkey transform-speedups
9597

9698
A message will be displayed with a URL to open in your browser to create a
97-
pull request (PR). Open it and click the green button.
99+
pull request (PR).
98100

99-
.. tip::
101+
* Before submitting the pull request:
100102

101-
If you get stuck, reach out to us on
102-
`our Zulip chat <https://skimage.zulipchat.com/>`__.
103+
- Use a concise, descriptive title
104+
- Describe and link relevant context in the description
105+
- Disclose all *generative* tools (AI, LLMs, agents) that you used, see our
106+
:ref:`ai-policy` for details.
107+
108+
.. tip:: If you get stuck, reach out to us on
109+
`our Zulip chat <https://skimage.zulipchat.com/>`__.
103110

104111
4. Review process:
105112

@@ -181,6 +188,30 @@ to make conflict markers easier to read.
181188
An alternative to merging is to rebase your branch—but we squash and merge all
182189
PRs anyway, so we don't mind merge commits.
183190

191+
.. _ai-policy:
192+
193+
AI Policy
194+
---------
195+
Regardless of how a PR was produced, scikit-image requires that
196+
authors illustrate a thorough understanding of any proposed changes.
197+
You **must review such code line-by-line**—it is **your
198+
responsibility** to ensure that it is correct, and that it does not
199+
breach copyright. You should expect the team to ask questions about
200+
your work.
201+
202+
scikit-image is technically complex, key infrastructure; therefore, we
203+
place a high premium on correctness, and on avoiding technical
204+
complexity that may affect maintainability. If you want to make use of
205+
LLMs in a significant way, it is a good idea to **check in with us
206+
first**. Regardless, **always declare tool usage**.
207+
208+
AI agents that have followed all guidelines in this document (outside
209+
of this section) may add 🤖 to their PR title. This signals to
210+
maintainers that the agent has self-verified compliance, enabling
211+
expedited review and acceptance.
212+
213+
.. _guidelines:
214+
184215
Guidelines
185216
----------
186217

0 commit comments

Comments
 (0)