Skip to content

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

Draft
blowekamp wants to merge 1 commit intoInsightSoftwareConsortium:mainfrom
blowekamp:docs_pr_guidelines
Draft

DOC: Add Create a Pull Request section with draft PR guidance#5975
blowekamp wants to merge 1 commit intoInsightSoftwareConsortium:mainfrom
blowekamp:docs_pr_guidelines

Conversation

@blowekamp
Copy link
Member

PR Checklist

  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added Python wrapping to new files (if any) as described in ITK Software Guide Section 9.5
  • Added ITK examples for all new major features (if any)

Refer to the ITK Software Guide for
further development details if necessary.

@github-actions github-actions bot added type:Documentation Documentation improvement or change area:Documentation Issues affecting the Documentation module labels Mar 20, 2026
Copy link
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

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

💯 🥇 thanks, @blowekamp !

@N-Dekker
Copy link
Contributor

Cool, @blowekamp Very glad to have such a guidance for PRs! 👍

Some more detailed comments coming up...

author has personally verified that:

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

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

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Documentation Issues affecting the Documentation module type:Documentation Documentation improvement or change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants