Repository navigation
Python: strengthen API design and PR review guidance #10038
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.
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
Open
Eduard van Valkenburg (eavanvalkenburg)
wants to merge
1
commit into
main
Choose a base branch
from
foundry-hosting-review
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+122
−6
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,6 +32,18 @@ prompts: | |
| reviewers only**. Automated/AI reviewers must ignore it and review the entire | ||
| change rather than narrowing scope to it. | ||
|
|
||
| For material Python public-API changes, include the following within this section: | ||
| - A short before/after usage example with public imports and initialization. | ||
| - The affected execution modes and their intentional differences. | ||
| - Changes to defaults, precedence, ownership, persistence, or compatibility. | ||
| - The agreed decision or investigation that supports the direction. An investigation | ||
| supplies evidence; its proposed implementation still needs maintainer agreement. | ||
|
|
||
| Use an options matrix only when interacting settings make it useful. Do not add a | ||
| separate mandatory section or repeat the canonical | ||
| [Python coding standards](../../../CODING_STANDARD.md). For semantic review, | ||
| follow the [Python review guidance](../../../../.github/instructions/python.instructions.md). | ||
|
Comment on lines
+35
to
+45
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This appears to be duplicated from the guidance provided in the top level repo skill. Maybe just linking to the document and section is enough here, if at all necessary. |
||
|
|
||
| ### `### Related Issue` | ||
| Link the issue the PR fixes using a GitHub closing keyword (`Fixes #123` / | ||
| `Closes #123`) so it closes automatically on merge. For a non-trivial change, | ||
|
|
@@ -40,6 +52,10 @@ agreed with the direction in an issue comment. A PR with no agreed issue may be | |
| closed without detailed review. Before opening, confirm there is no other open PR | ||
| for the same issue; if there is, explain how this PR differs. | ||
|
|
||
| A team-only issue, assignment, investigation, `/plan` comment, or suggested option | ||
| does not authorize implementation. Check the agreed scope and readiness; team-only | ||
| work remains unavailable for community pickup unless maintainers explicitly open it. | ||
|
|
||
| For a trivial change that does not require an issue, replace the `Fixes #` | ||
| placeholder with `N/A - trivial change` and briefly explain why the change is an | ||
| obvious correction whose desired result is not reasonably in dispute. | ||
|
|
||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this section maybe making a mention on "mutually exclusive" combinations of parameters too.