Skip to content

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

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

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 51 minutes.

Check out review usage here.

View limit details

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

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 159862ae-a8bc-48e3-8a29-da342b6d301b

📥 Commits

Reviewing files that changed from the base of the PR and between 8ca8562 and 38309d0.

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

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: a665800e-097f-4533-80bf-419758708559

📥 Commits

Reviewing files that changed from the base of the PR and between 3c6c5d9 and 8ca8562.

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

38-38: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Improved column alignment in the repository structure diagram.
    • Updated the documented location of the contribution guidelines file.

Walkthrough

The repository structure diagram in .github/CONTRIBUTING.md now aligns comments and lists CONTRIBUTING.md under .github/.

Changes

Repository documentation

Layer / File(s) Summary
Update repository structure diagram
.github/CONTRIBUTING.md
The diagram aligns comments and moves CONTRIBUTING.md from the repository root to .github/CONTRIBUTING.md.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the main change and its scope, but it omits the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections from the repository template. Rewrite the description using the repository template. Add the required headings, complete the RSR Quality Checklist, and describe the testing performed. State that Screenshots are not applicable if no screenshots are needed.
✅ 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 describes the main change: correcting the documented location of the contributing guide.

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 checks the tree
Aligned marks now clearly show
.github/ holds the file
Root paths rest in order
The map is neat and true

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 3c6c5d9 to 8ca8562 Compare September 19, 2026 14:58
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.
@hyperpolymath
hyperpolymath merged commit 67b1855 into main Sep 19, 2026
31 of 35 checks passed
@hyperpolymath
hyperpolymath deleted the fix/contributing-guide-structure-tree branch September 19, 2026 17:53
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