Skip to content

Commit 8fcd691

Browse files
authored
Merge pull request InsightSoftwareConsortium#5975 from blowekamp/docs_pr_guidelines
DOC: Add Create a Pull Request section with draft PR guidance
2 parents f87d036 + bf38fb7 commit 8fcd691

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

Documentation/docs/contributing/index.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,36 @@ Push commits in your topic branch for review by the community:
226226
git review-push --force
227227
```
228228

229-
A URL will be provided in the terminal -- visit this url to review the topic
230-
and open a pull request.
229+
A URL will be provided in the terminal.
230+
231+
(create-a-pr)=
232+
Create a Pull Request
233+
---------------------
234+
235+
Follow the URL provided in the terminal to open a pull request against the
236+
upstream repository. **Open the pull request as a Draft** until the automated
237+
tests pass. A draft PR signals that the work is still in progress and prevents
238+
reviewers from spending time on code that is not yet ready.
239+
240+
Once the CI tests pass and you are satisfied with the change, convert the draft
241+
to *Ready for Review* and request reviewers. This notifies maintainers that the
242+
code is ready for their attention and ensures their review time is spent
243+
effectively.
244+
245+
```{important}
246+
**Please open AI-agent-assisted pull requests in Draft mode.** We prefer that
247+
an AI-agent-assisted PR not be converted to *Ready for Review* until the human
248+
author has personally verified that:
249+
250+
- all automated CI tests pass,
251+
- the implementation is correct, complete and fully understood,
252+
- the PR description accurately reflects the changes made.
253+
254+
Reviewer time is a finite human resource. Please allow at least 1 working day
255+
for low-impact changes (e.g., single test changes, documentation updates) and
256+
longer for changes that impact core infrastructure or fundamental algorithmic
257+
behavior before merging.
258+
```
231259

232260
Optionally, discuss the change by opening a topic on [ITK's Discourse].
233261

0 commit comments

Comments
 (0)