fix(docs): list the contributing guide where it actually lives - #64
Conversation
The repository-structure block listed `CONTRIBUTING.md` at the repository root, but the guide lives at `.github/CONTRIBUTING.md` - the entry pointed at a location it had already moved away from. The entry is moved under the tree's existing `.github/` branch, at the block's own comment column; the layout of the rest of the tree is untouched.
hyperpolymath
changed the title
b23365d to
bc57f97
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (22)
🔇 Additional comments (1)
📝 SummarySummary by CodeRabbit
WalkthroughThe repository structure diagram now lists ChangesRepository documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Description checkExplanation The description explains the main documentation change, but it does not use the required template sections. It omits the changes list, quality checklist, testing details, and screenshots section. It also introduces an additional Resolution Rewrite the description with the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. Record the test result and checklist status. Either document the
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. A rabbit checked the tree, Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
…ting guide
The guide is instantiated from the estate template, whose own copy legitimately holds
`{{MAIN_BRANCH}}`. Here it was never substituted, so the reader is told to check whether
a bug "is already fixed in `{{MAIN_BRANCH}}`". Resolved to this repository's default
branch. One token, no other change.
|
The agent ran but didn't make any changes. The issues may already be fixed or require manual intervention. |
1 participant
The "Repository Structure" block still listed
CONTRIBUTING.mdat the repository root, but the guide lives at.github/CONTRIBUTING.md— the entry pointed at a location it had already moved away from.This is the only change: the entry moves under the tree's existing
.github/branch, at the block's own comment column. The tree already rendered correctly and its layout is untouched.The contributing guide was instantiated from the estate template and kept one of the template's tokens verbatim:
{{MAIN_BRANCH}}, inThe token is correct in the template itself, but a reader of this repository sees it literally. It resolves to this repository's default branch. One token — nothing else in the guide changes.