-
Notifications
You must be signed in to change notification settings - Fork 1
docs(AGENTS): PR↔Issue linkage policy #104
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
Conversation
…se PRs, and docs guard
|
Warning Rate limit exceeded@flyingrobots has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 55 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (3)
Summary by CodeRabbit
WalkthroughTwo documentation files added: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Areas requiring attention:
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (5 warnings)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…/M2 work (regen rollup)
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.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/echo-total.md (1)
1-5: 🚨 BLOCKER: Regenerate docs/echo-total.md before merge.The CI pipeline failed with:
docs/echo-total.md is out of date. Run 'make echo-total'. Since this is a generated artifact, you must re-run the generator script before committing. The file header (line 3) explicitly states not to edit this rollup directly—all edits belong in source docs underdocs/.Run
make echo-totalorscripts/gen-echo-total.shlocally and stage the result. The newdocs/ROADMAP.mdadditions will then be automatically incorporated into this rollup.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
AGENTS.mdis excluded by!*.md
📒 Files selected for processing (2)
docs/ROADMAP.md(1 hunks)docs/echo-total.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Docs Rollup Check
docs/echo-total.md
[error] 1-1: docs/echo-total.md is out of date. Run 'make echo-total' (or scripts/gen-echo-total.sh) and commit the result.
🪛 LanguageTool
docs/ROADMAP.md
[grammar] ~61-~61: Ensure spelling is correct
Context: ...ect with the backlog label and can be re‑prioritized later. --- ## Immediate Plan (Next PR...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~77-~77: Ensure spelling is correct
Context: ...aintainers: keep this file in sync when re‑prioritizing or moving issues between milestones. Th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Security Audit
🔇 Additional comments (2)
docs/ROADMAP.md (2)
1-4: ✅ Excellent application of PR↔Issue linkage pattern.The "Immediate Plan" section (lines 65-73) correctly demonstrates the PR↔Issue linkage policy outlined in the PR objectives: each planned PR explicitly references the issue it closes using the
Closes #<id>format. This is exactly what the policy requires and serves as a model for future PRs.
61-77: Character encoding consistency note.LanguageTool flagged the orthography in lines 61 and 77 regarding "re‑prioritized" and "re‑prioritizing". The issue stems from the use of non‑breaking hyphens (U+2011
‑) instead of standard ASCII hyphens (U+002D-). While these appear intentional (consistent with other hyphenated terms like "Sweep‑and‑Prune" on line 25), verify that:
- Your editor/CI toolchain handles non‑breaking hyphens correctly across all rendering contexts.
- The project's documentation style guide intentionally adopts non‑breaking hyphens (or recommends standard ASCII hyphens for compatibility).
If standard ASCII hyphens are preferred for maximum compatibility, replace:
- Line 61:
re‑prioritized→re-prioritized- Line 77:
re‑prioritizing→re-prioritizing
… Blocked/Blocking fields (regen rollup)
This PR updates AGENTS.md to document the PR↔Issue linkage policy.\n\nCloses #103\n\nHighlights\n- Every PR must link to an Issue; if none exists, open one first.\n- Include 'Closes #' in PR bodies for auto-closure on merge.\n- Keep PRs single-purpose; update execution-plan/decision-log when non-doc code changes.\n