docs: add strict bot policies (non-loop mode)#142
Conversation
hlin99-Review-BotX
left a comment
There was a problem hiding this comment.
Reviewed commit e49f5b6. Several issues found:
-
bot/DESIGN_PRINCIPLES.mdis empty — contains only a header (# Design Principles — xPyD-proxy). BothENTRY.mdandAUTHOR_POLICY.mdlist it as mandatory reading, but it provides no content. Either populate it or remove the references. -
Active PR Maintenance section dropped entirely — the old
BOT_POLICY.mdhad a detailed "Active PR Maintenance" section (branch update, CI check, review comment check, re-request review cycle). None of this appears in any of the new files. If this is intentional for "non-loop mode",AUTHOR_POLICY.mdshould still document the expected maintenance workflow or explicitly state there is none. -
Rate limiting guidance removed — the old policy had a "Rate Limiting" section for reviewers. The new
REVIEW_POLICY.mdhas no equivalent. Consider adding it back. -
PR description contradicts content — description says "no design gate", but
REVIEW_POLICY.mdchecklist still includes "Design conformance: Implementation must match the linked GitHub Issue design." This is contradictory — either remove the design conformance row or update the PR description. -
No linked issue — PR body does not reference any GitHub Issue. Per existing policy, PRs should reference related issues.
|
Addressed all feedback from review:
Fixed in |
09489f9 to
a77202c
Compare
…141) Migrated to xPyD-integration repo: - tests/integration/ (~115 tests) - tests/stress/ (~10 tests) Also removed: - sim_adapter.py (no longer needed) - tests/conftest.py (only used by integration tests) - xpyd-sim dev dependency - Fixed build job CI to run unit tests Co-authored-by: hlin99 <hlin99@users.noreply.github.com>
a77202c to
1e12d1c
Compare
hlin99-Review-Bot
left a comment
There was a problem hiding this comment.
Reviewed commit 1e12d1c. CI is fully green and the PR is mergeable, but several issues remain:
-
PR title/description mismatch with actual changes. Title says "docs: add strict bot policies (non-loop mode)" but the only change in this commit vs main is to
.github/workflows/trigger-integration.yml. This is aci:change, notdocs:. The description also does not match the diff content. -
No linked GitHub Issue. Per BOT_POLICY.md, PRs should reference related issues.
-
Workflow change review:
- Adding
pull_requesttrigger to run integration tests on PRs is a reasonable improvement. - Switching from
GITHUB_TOKENtoINTEGRATION_TOKENmakes sense for cross-repo dispatch (GITHUB_TOKEN lacks permissions forrepository_dispatchon other repos). - The
if/elselogic for PR vs release event types is correct. - Minor: no
permissions:block is specified. Consider adding minimal permissions for security hardening.
- Adding
Please fix the PR title (should be ci: prefix) and update the description to accurately reflect the actual change.
Split BOT_POLICY.md into modular files under bot/: - ENTRY.md: overview, navigation, and general rules - REVIEW_POLICY.md: reviewer bot rules, checklist, rate limiting - AUTHOR_POLICY.md: author bot rules, active PR maintenance (triggered mode) - DESIGN_PRINCIPLES.md: architecture constraints and coding guidelines Addresses review feedback: - Populated DESIGN_PRINCIPLES.md with real content - Added Active PR Maintenance section to AUTHOR_POLICY.md (triggered mode) - Added Rate Limiting section to REVIEW_POLICY.md - Removed design conformance from review checklist (no design gate) - Pre-commit formatting fixes (ci.yml EOF, test_metrics.py blank line) Signed-off-by: hlin99 <tony.lin@intel.com>
|
All 5 items addressed in fe36881:
|
hlin99-Review-BotX
left a comment
There was a problem hiding this comment.
Reviewed commit 1e12d1c. CI is green and PR is mergeable, but several issues must be fixed:
-
PR title/description mismatch. Title says
docs: add strict bot policies (non-loop mode)but the actual changes are removing integration/stress tests, sim_adapter, and xpyd-sim dependency, plus modifying CI workflows. The title prefix should berefactor:orci:depending on the primary intent. The description also does not reflect the actual diff. -
No linked GitHub Issue. Per BOT_POLICY.md, PRs should reference related issues.
-
Co-authored-by trailer with noreply address. The commit includes
Co-authored-by: hlin99 <hlin99@users.noreply.github.com>which violates BOT_POLICY.md: "Never add Co-authored-by trailers to commit messages" and "Never use the GitHub noreply address". -
Missing newline at end of
.github/workflows/ci.yml. The diff shows\ No newline at end of file— the last line of the build job should end with a newline. -
Workflow change notes:
- Adding
pull_requesttrigger totrigger-integration.ymland switching toINTEGRATION_TOKENis reasonable for cross-repo dispatch. - The if/else logic for PR vs release event types is correct.
- Consider adding a
permissions:block for security hardening.
- Adding
-
Previous review issues (from e49f5b6) appear moot — the PR content has completely changed from the prior commit (was adding bot policy docs, now is removing tests). This suggests a force-push or rebase that replaced the entire PR content, which makes the PR history confusing. Consider opening a new PR for this separate change.
hlin99-Review-Bot
left a comment
There was a problem hiding this comment.
Reviewed commit fe36881. Submitting REQUEST_CHANGES for the following reasons:
1. Merge conflicts (blocking). mergeable == false / mergeable_state: dirty. The branch appears to include commit 1e12d1c which duplicates the already-merged PR #141 (now c83b397 on main). The branch needs to be rebased or updated to resolve conflicts before review can proceed.
2. Previous feedback not addressed. My prior review on 1e12d1c raised:
- No linked GitHub Issue — still missing.
- PR title/description mismatch — the new commit
fe36881does add bot policy docs, making thedocs:prefix more appropriate now. However, the PR also includes CI workflow changes (.github/workflows/ci.ymlandtrigger-integration.yml) which areci:scope changes, notdocs:. Consider splitting CI changes into a separate PR or updating the title to reflect both scopes.
3. Content review of bot/ docs (fe36881):
ENTRY.md,REVIEW_POLICY.md,AUTHOR_POLICY.md,DESIGN_PRINCIPLES.md— content is well-structured and consistent with the existingBOT_POLICY.mdin the repo root. However, this raises a question: isBOT_POLICY.mdin the repo root being replaced by thebot/directory? If so, the PR should remove or deprecate the rootBOT_POLICY.md. If both coexist, there is a risk of policy drift between the two sources of truth.
4. CI workflow changes:
ci.yml: Removing integration/stress test steps is consistent with the migration in #141. The smoke-test job now runs only unit tests — this is correct.trigger-integration.yml: Addingpull_requesttrigger and switching toINTEGRATION_TOKENfor cross-repo dispatch is reasonable. The if/else logic for PR vs release events is correct. Minor suggestion: consider adding apermissions:block for security hardening.
5. pyproject.toml: Removing xpyd-sim from dev dependencies is consistent with #141.
6. Test/file removals: sim_adapter.py, tests/conftest.py, and all tests/integration/ and tests/stress/ files are removed. This duplicates what was already done in #141 — further evidence the branch has a conflict/duplication issue.
Please resolve the merge conflicts first, then address the remaining feedback.
|
Rebased branch onto latest Addressing all review feedback on
Pre-commit: all pass. Tests: 393 passed. |
Apply proxy-level strict review/author rules. Non-loop mode: bot never merges/closes. Direct code review (no design gate).