Skip to content

fix(docs): list the contributing guide where it actually lives - #119

Merged
hyperpolymath merged 2 commits into
mainfrom
fix/contributing-guide-structure-tree
Sep 19, 2026
Merged

hyperpolymath merged 2 commits into
mainfrom
fix/contributing-guide-structure-tree

Conversation

@hyperpolymath

@hyperpolymath hyperpolymath commented Sep 19, 2026 •

Copy link
Copy Markdown
Owner

The "Repository Structure" block still 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.

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}}, in

  1. Check if it's already fixed in {{MAIN_BRANCH}}

The 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.

@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 52304833-ddfb-4e8b-984d-b326077645af

📥 Commits

Reviewing files that changed from the base of the PR and between 74f60da and dcf1bc0.

📒 Files selected for processing (1)
  • .github/CONTRIBUTING.md

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. (24)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: analyze (actions, none)
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: Validate eclexiaiser manifest
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Groove manifest check
  • GitHub Check: Hypatia neurosymbolic scan
  • GitHub Check: panic-attack assail
  • GitHub Check: Zig FFI builds + tests (Zig 0.14.0)
  • GitHub Check: ABI ↔ FFI structural conformance
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

38-38: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Reformatted the repository structure example in the contribution guidelines for improved readability.
    • Updated the example’s file placement and formatting to reflect the current repository layout.
    • No functional or prose content changes.

Walkthrough

The contribution guide repository tree now uses a text code fence, tighter comment spacing, and a CONTRIBUTING.md entry under .github/.

Changes

Contribution guide

Layer / File(s) Summary
Repository tree formatting
.github/CONTRIBUTING.md
The tree block now uses the text language tag. Trailing comment padding was removed. The .github/ directory now lists CONTRIBUTING.md.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the intended documentation change, but it does not follow the repository template. It omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sect… Rewrite the description using the repository template. Add the required sections, complete the checklist, document testing, state whether screenshots are applicable, and align the described changes with the actual diff.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the main change: correcting the documented location of the contributing guide.
Full details: Description check

Explanation

The description explains the intended documentation change, but it does not follow the repository template. It omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections. It also describes a {{MAIN_BRANCH}} token issue that is not included in the stated change summary.

🤖 Coding task started


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.

❤️ Share

A rabbit tidies each tree line,
With comments neat and spacing fine.
The .github/ path now shows,
Where CONTRIBUTING.md belongs.
The guide rests clear and bright.

Comment @coderabbitai help to get the list of available commands.

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 hyperpolymath changed the title fix(docs): rebuild the mangled repository-structure tree fix(docs): list the contributing guide where it actually lives Sep 19, 2026
@hyperpolymath
hyperpolymath force-pushed the fix/contributing-guide-structure-tree branch from 74f60da to dcf1bc0 Compare September 19, 2026 14:57
coderabbitai[bot]
coderabbitai Bot previously approved these changes Sep 19, 2026
…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.
@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

⚠️ Coding task failed

The task could not be completed. Open the task for details or retry.

@hyperpolymath
hyperpolymath merged commit 9f299dc into main Sep 19, 2026
30 of 35 checks passed
@hyperpolymath
hyperpolymath deleted the fix/contributing-guide-structure-tree branch September 19, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant