From 5b39d4bf1452d1e7a5de170ded21dd1494bcca74 Mon Sep 17 00:00:00 2001 From: Bradley Lowekamp Date: Fri, 20 Mar 2026 21:06:30 +0000 Subject: [PATCH 1/2] DOC: Add Create a Pull Request section with draft PR guidance --- Documentation/docs/contributing/index.md | 30 ++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/Documentation/docs/contributing/index.md b/Documentation/docs/contributing/index.md index 8665b5d18f8..de394dfcc4b 100644 --- a/Documentation/docs/contributing/index.md +++ b/Documentation/docs/contributing/index.md @@ -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, +- 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. +``` Optionally, discuss the change by opening a topic on [ITK's Discourse]. From bf38fb7e647a4ebb40865f67093507562c8329ef Mon Sep 17 00:00:00 2001 From: "Hans J. Johnson" Date: Fri, 27 Mar 2026 11:42:10 -0500 Subject: [PATCH 2/2] DOC: Soften tone and incorporate reviewer feedback on AI PR guidelines --- Documentation/docs/contributing/index.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Documentation/docs/contributing/index.md b/Documentation/docs/contributing/index.md index de394dfcc4b..9863f798fd9 100644 --- a/Documentation/docs/contributing/index.md +++ b/Documentation/docs/contributing/index.md @@ -243,16 +243,18 @@ 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 +**Please open AI-agent-assisted pull requests in Draft mode.** We prefer that +an AI-agent-assisted PR 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, +- the implementation is correct, complete and fully understood, - 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. +Reviewer time is a finite human resource. Please allow at least 1 working day +for low-impact changes (e.g., single test changes, documentation updates) and +longer for changes that impact core infrastructure or fundamental algorithmic +behavior before merging. ``` Optionally, discuss the change by opening a topic on [ITK's Discourse].