fix(docs): list the contributing guide where it actually lives - #96
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.
|
Warning Review limit reachedNext included review available in 29 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
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. (28)
🧰 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 (1)
📝 SummarySummary by CodeRabbit
WalkthroughThe contribution guide replaces repository template placeholders with concrete ChangesContribution guide updates
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
Full details: Title checkExplanation The title describes moving the contributing guide entry in a repository tree. The recorded changes instead replace template placeholders in Full details: Description checkExplanation The description does not follow the repository template. It omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. It also conflicts with the recorded objectives and change summary. Resolution Rewrite the description using the template headings. Document the placeholder substitutions and other mechanical repairs, record testing results, complete the applicable checklist items, and explain whether screenshots or terminal output are applicable. 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 clone command. 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.