Repository navigation
fix(docs): list the contributing guide where it actually lives - #80
Conversation
Mechanical repairs to the guide, each anchored on a known-broken form:
- substituted {{FORGE}}
- substituted {{OWNER}}
- substituted {{REPO}}
No prose is rewritten; only the broken forms are corrected.
|
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. (30)
🧰 Additional context used🪛 markdownlint-cli2 (0.23.2).github/CONTRIBUTING.md[warning] 9-9: Headings should be surrounded by blank lines (MD022, blanks-around-headings) [warning] 12-12: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 🔇 Additional comments (3)
📝 SummarySummary by CodeRabbit
WalkthroughThe contributing guide replaces repository placeholders with concrete ChangesRepository documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Description checkExplanation The description explains some changes, but it omits the required template headings, RSR Quality Checklist, Testing section, and Screenshots section. It also does not describe all changes listed in the PR objectives. Resolution Use the repository template headings. Add the complete RSR Quality Checklist with applicable items marked, record the testing performed, state whether screenshots or terminal output apply, and update the change summary to include all repairs in the PR objectives.
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 checks the guide with care Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
The tree block was hard-wrapped by the AsciiDoc->Markdown conversion, so it
rendered as a paragraph rather than a tree, and it still listed
CONTRIBUTING.md at the repository root, where the guide no longer lives.
Rebuilt from the tree's own content: depth recovered from the `|` continuation
bars that survived the wrap, the guide entry moved under `.github/`, `#`
escapes unescaped, the last entry of each group restored to `└──`, and the
block fenced so it renders as a tree. Every annotation ("Perimeter 1-2") is
preserved - nothing is invented and nothing is dropped.
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. Placeholder tokens in the block resolve to real values.
hyperpolymath
changed the title
…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.
|
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.Placeholder tokens in the block resolve to real values.
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.