Skip to content

fix(docs): repoint references to the relocated contributing guide - #95

Merged
hyperpolymath merged 2 commits into
mainfrom
refactor/contributing-guide-link-repair
Sep 19, 2026
Merged

hyperpolymath merged 2 commits into
mainfrom
refactor/contributing-guide-link-repair

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

fix(docs): repoint references to the relocated contributing guide

The guide moved to .github/CONTRIBUTING.md; these references still resolved
against the old root location and 404 from where they are written. Rewritten
using the correct relative depth.

  • .github/CONTRIBUTING.md: in-guide links withdrawn one level to the root

The guide moved to .github/CONTRIBUTING.md; these references still resolved
against the old root location and 404 from where they are written. Rewritten
using the correct relative depth.

- `.github/CONTRIBUTING.md`: in-guide links withdrawn one level to the root
@coderabbitai

coderabbitai Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

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: 725e2e41-64d5-48b2-8924-d5052620324d

📥 Commits

Reviewing files that changed from the base of the PR and between 7a4fa08 and e5c6330.

📒 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. (28)
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: build
  • GitHub Check: security
  • GitHub Check: check
  • GitHub Check: Build Assets
  • GitHub Check: Code Quality
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Dependency Review
  • GitHub Check: RSR Compliance Check
  • GitHub Check: Build Container Image
  • GitHub Check: Test Suite
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)

28-28: LGTM!

Also applies to: 274-274


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated links in the contributing guidelines so the Code of Conduct and Security Vulnerabilities references point to the correct documents.

Walkthrough

The contributing guide changes two documentation links to parent-directory-relative paths. The links now target ../CODE_OF_CONDUCT.adoc and ../SECURITY.md.

Changes

Documentation links

Layer / File(s) Summary
Correct relative link targets
.github/CONTRIBUTING.md
The Code of Conduct and security links now use parent-directory-relative paths.

Priority: ⬇️ Low

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

Change: Bug fix

Suggested reviewers: metadatastician

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description accurately explains the relocation and the required link changes, but it does not follow the repository template. It omits the required change type, related issues, testing details, ch… Update the description to use the repository template. Mark the documentation change type, list the specific link changes, state whether testing was performed, complete the applicable checklist items, and mark non-applicable sections clearl…
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies a documentation fix for references affected by the relocated contributing guide.
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.
Full details: Description check

Explanation

The description accurately explains the relocation and the required link changes, but it does not follow the repository template. It omits the required change type, related issues, testing details, checklist, and other template sections.

Resolution

Update the description to use the repository template. Mark the documentation change type, list the specific link changes, state whether testing was performed, complete the applicable checklist items, and mark non-applicable sections clearly.


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 each careful link
Parent paths now point and sync
Code of Conduct finds its way
Security joins the guide today
Two small hops, the paths are right
Neat and clear by moonlit light

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

@hyperpolymath
hyperpolymath merged commit 53a4e16 into main Sep 19, 2026
20 of 31 checks passed
@hyperpolymath
hyperpolymath deleted the refactor/contributing-guide-link-repair branch September 19, 2026 13:44
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