docs(AGENTS): codify recurring PR review feedback as rules#1700
Open
wowi42 wants to merge 4 commits intopyinfra-dev:3.xfrom
Open
docs(AGENTS): codify recurring PR review feedback as rules#1700wowi42 wants to merge 4 commits intopyinfra-dev:3.xfrom
wowi42 wants to merge 4 commits intopyinfra-dev:3.xfrom
Conversation
Mined the last 100 closed PRs and added the patterns reviewers raised more than once as explicit rules so future agents follow them up front: - Shell safety extended to non-string user input (ports/ints). - Optional params: T | None, not Optional[T]. - Distinguish unset from empty (`is not None` vs truthy). - FactBase typing: annotate command/process; output is already a list. - Prefer `! test -e PATH || cat PATH` over `cat PATH || true`. - Reuse helpers in operations.util before adding new ones. - No `assert` in src/ — raise an exception (python -O strips asserts). - PR checklist: atomic scope (no drive-by refactors / __init__.py edits).
Collaborator
|
I added a new |
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
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
Mined the last 100 closed PRs on this repo and surfaced the patterns reviewers raised more than once. Added them to
AGENTS.mdas explicit rules so future agents/contributors follow them up-front instead of learning them in review.New / extended rules:
T | None, notOptional[T].if x is not None:, not truthyif x:, when a param isT | None.command()/process()and don't re-wrapoutput(it's already alist[str]).! test -e PATH || cat PATHovercat PATH 2>/dev/null || trueso realcaterrors aren't swallowed.operations.util.file_utilsbefore adding new chown/chmod/path utilities.assertinsrc/,python -Ostrips them; raise an explicit exception instead.__init__.pyre-exports, drive-by refactors, and unrelated test edits.Related issues
None.
Test plan
AGENTS.mdrenders correctly as Markdown locally.Labels
Suggested:
docs,meta.Checklist
3.x