Add a new "Opening a PR" section to the contribution guide #21298
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary -- This PR adds a new section to CONTRIBUTING.md describing the expected contents of the PR summary and test plan, using the ecosystem report, and communicating the status of a PR. This seemed like a pretty good place to insert this in the document, at the end of the advice on preparing actual code changes, but I'm certainly open to other suggestions about both the content and placement. Test Plan -- Future PRs :)
amyreese
approved these changes
Nov 6, 2025
CONTRIBUTING.md
Outdated
Comment on lines
296
to
300
| We don't currently have any rules around AI usage or disclosure, but remember | ||
| that this PR summary will be our first impression of your PR. The higher its | ||
| quality and accuracy, the more easily we can start reviewing your PR. However | ||
| you generate the contents of this summary, please ensure that it corresponds to | ||
| the code and doesn't include extraneous or misleading information. |
Contributor
There was a problem hiding this comment.
Would it be worth adding something around keeping things brief of "succinct" as a way to discourage long or overly-fluffed summaries?
Contributor
Author
There was a problem hiding this comment.
Yeah, I think that's a good idea. I'll think more about how to work it in.
MichaReiser
reviewed
Nov 7, 2025
Member
MichaReiser
left a comment
MichaReiser
left a comment
There was a problem hiding this comment.
Thanks for working on this. This is great. I've a few smaller suggestions around pharsing.
CONTRIBUTING.md
Outdated
Comment on lines
296
to
298
| We don't currently have any rules around AI usage or disclosure, but remember | ||
| that this PR summary will be our first impression of your PR. The higher its | ||
| quality and accuracy, the more easily we can start reviewing your PR. However |
Member
There was a problem hiding this comment.
This sounds a bit intimidating (even when not using AI). I think I'd frame it around AI being useful, but a successful AI generated contribution is reviewed and the summary is editoralized before submitting the PR.
CONTRIBUTING.md
Outdated
Comment on lines
318
to
319
| differences are reported, you should go through them and make sure they look | ||
| correct. After going through the results of the ecosystem check, you should |
Member
There was a problem hiding this comment.
Rather than making this mandatory, I'd formalize this more around how them review and discussing the ecosystem changes helps us being more effective at reviewing their PR.
Co-authored-by: Micha Reiser <micha@reiser.io>
MichaReiser
approved these changes
Nov 10, 2025
dcreager
added a commit
that referenced
this pull request
Nov 11, 2025
* origin/main: (38 commits) [ty] Make implicit submodule imports only occur in global scope (#21370) [ty] introduce local variables for `from` imports of submodules in `__init__.py(i)` (#21173) [`ruff`] Ignore `str()` when not used for simple conversion (`RUF065`) (#21330) [ty] implement `typing.NewType` by adding `Type::NewTypeInstance` [ty] supress inlay hints for `+1` and `-1` (#21368) [ty] Use type context for inference of generic constructors (#20933) [ty] Improve generic call expression inference (#21210) [ty] supress some trivial expr inlay hints (#21367) [`configuration`] Fix unclear error messages for line-length values exceeding `u16::MAX` (#21329) [ty] Fix incorrect inference of `enum.auto()` for enums with non-`int` mixins, and imprecise inference of `enum.auto()` for single-member enums (#20541) [`refurb`] Detect empty f-strings (`FURB105`) (#21348) [ty] provide `import` completion when in `from <name> <name>` statement (#21291) [ty] elide redundant inlay hints for function args (#21365) Fix syntax error false positive on alternative `match` patterns (#21362) Add a new "Opening a PR" section to the contribution guide (#21298) [`flake8-simplify`] Fix SIM222 false positive for `tuple(generator) or None` (`SIM222`) (#21187) Rebuild ruff binary instead of sharing it across jobs (#21361) [ty] Fix `--exclude` and `src.exclude` merging (#21341) [ty] Add support for properties that return `Self` (#21335) Add upstream linter URL to `ruff linter --output-format=json` (#21316) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a new section to CONTRIBUTING.md describing the expected contents of the PR summary and test plan, using the ecosystem report, and communicating the status of a PR.
This seemed like a pretty good place to insert this in the document, at the end of the advice on preparing actual code changes, but I'm certainly open to other suggestions about both the content and placement.
Test Plan
Future PRs :)