Document required PR workflow#5
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a 'Contribution Flow' section to the AGENTS.md file, detailing the standard procedures for branching, validation, and pull requests. Review feedback suggests clarifying the validation suite by referencing the README, verifying the exact names of CI checks like 'codeql' to avoid configuration mismatches, and explicitly mentioning the requirement for formal approval before merging.
|
|
||
| - Do not push directly to `main`. | ||
| - Create a topic branch for every change. | ||
| - Run the mandatory validation suite before opening a PR. |
There was a problem hiding this comment.
The term "mandatory validation suite" is ambiguous. Referencing the "Development checks" section in README.md would provide the necessary context for contributors and automated agents to know which commands to run.
| - Run the mandatory validation suite before opening a PR. | |
| - Run the mandatory validation suite (see Development checks in README.md) before opening a PR. |
| - Create a topic branch for every change. | ||
| - Run the mandatory validation suite before opening a PR. | ||
| - Open a PR against `main`. | ||
| - Wait for required checks: `python` and `codeql`. |
There was a problem hiding this comment.
The "codeql" check is not mentioned in the README.md or development setup. If this check is not configured in CI, automated agents may wait indefinitely for a status that never appears. Ensure the check names match the exact strings reported by the CI provider.
| - Run the mandatory validation suite before opening a PR. | ||
| - Open a PR against `main`. | ||
| - Wait for required checks: `python` and `codeql`. | ||
| - Resolve review comments and conversations before merge. |
There was a problem hiding this comment.
PR workflows typically require at least one approval in addition to resolving comments. If this repository enforces approvals, it should be explicitly stated here so that agents know to wait for a formal approval state before attempting a merge.
| - Resolve review comments and conversations before merge. | |
| - Obtain approval and resolve all review comments and conversations before merge. |
Record the branch-and-PR contribution flow in AGENTS.md so future agent sessions do not push directly to main. Validation: .venv/bin/pre-commit run --all-files; .venv/bin/ruff check .; .venv/bin/bandit -c pyproject.toml -r src; git ls-files -z | xargs -0 .venv/bin/detect-secrets-hook --baseline .secrets.baseline; PYTHONPATH=src python3 -m unittest discover -s tests; python3 -m compileall -q src tests.
rgerhards
force-pushed
the
docs/agent-pr-flow
branch
from
fb336e6 to
2a38222
Compare
Address PR review feedback by linking validation wording to README development checks, naming required GitHub checks exactly, and documenting approval before merge. Validation: .venv/bin/pre-commit run --all-files; .venv/bin/ruff check .; .venv/bin/bandit -c pyproject.toml -r src; git ls-files -z | xargs -0 .venv/bin/detect-secrets-hook --baseline .secrets.baseline; PYTHONPATH=src python3 -m unittest discover -s tests; python3 -m compileall -q src tests.
1 participant
Summary
Validation