Skip to content

DOC: Add Create a Pull Request section with draft PR guidance #5975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
blowekamp wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −2
Draft

DOC: Add Create a Pull Request section with draft PR guidance #5975

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions Documentation/docs/contributing/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,34 @@ Push commits in your topic branch for review by the community:
git review-push --force
```

A URL will be provided in the terminal -- visit this url to review the topic
and open a pull request.
A URL will be provided in the terminal.

(create-a-pr)=
Create a Pull Request
---------------------

Follow the URL provided in the terminal to open a pull request against the
upstream repository. **Open the pull request as a Draft** until the automated
tests pass. A draft PR signals that the work is still in progress and prevents
reviewers from spending time on code that is not yet ready.

Once the CI tests pass and you are satisfied with the change, convert the draft
to *Ready for Review* and request reviewers. This notifies maintainers that the
code is ready for their attention and ensures their review time is spent
effectively.

```{important}
**AI-agent-assisted pull requests must be opened in Draft mode.** An
agent-created PR must not be converted to *Ready for Review* until the human
author has personally verified that:

- all automated CI tests pass,
- the implementation is correct and complete,
Copy link
Contributor

@N-Dekker N-Dekker Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please make this:

- the implementation is correct, complete and well understood,

I think it's essential that we keep understanding the code, even when it is partially AI generated, to avoid cognitive debt. As I mentioned at https://discourse.itk.org/t/ai-generated-pull-requests-overwhelming-hard-to-review-carefully/7728/12?u=niels_dekker

- the PR description accurately reflects the changes made.

Reviewer time is a finite human resource. Do not request a review before these
conditions are met.
Comment on lines +254 to +255
Copy link
Contributor

@N-Dekker N-Dekker Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add something like:

When you request a reviewer to review your PR, allow the reviewer a
reasonable amount of time to do the review, before the PR is merged.

```

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

Expand Down
Loading