Skip to content

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

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

hyperpolymath merged 1 commit 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.

  • CODE_OF_CONDUCT.adoc: ./CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • RSR_COMPLIANCE.adoc: ./CONTRIBUTING.md -> .github/CONTRIBUTING.md
  • SECURITY.adoc: ./CONTRIBUTING.md -> .github/CONTRIBUTING.md

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.

- `CODE_OF_CONDUCT.adoc`: ./CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `RSR_COMPLIANCE.adoc`: ./CONTRIBUTING.md -> .github/CONTRIBUTING.md
- `SECURITY.adoc`: ./CONTRIBUTING.md -> .github/CONTRIBUTING.md
@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: c7c121db-ce75-499b-b0e3-898a6ae28293

📥 Commits

Reviewing files that changed from the base of the PR and between 5d77513 and f34bd6b.

📒 Files selected for processing (3)
  • CODE_OF_CONDUCT.adoc
  • RSR_COMPLIANCE.adoc
  • SECURITY.adoc

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. (23)
  • GitHub Check: governance / Live Actions policy (credentialed advisory)
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Debt ratchet
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Actions lockfile verify
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Exemption ratchet
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Security policy checks
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Groove manifest check
  • GitHub Check: CodeQL Analysis (actions, none)
🔇 Additional comments (3)
CODE_OF_CONDUCT.adoc (1)

250-250: LGTM!

RSR_COMPLIANCE.adoc (1)

420-420: LGTM!

SECURITY.adoc (1)

266-266: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated references to the contribution guidelines to point to their new location.
    • Corrected cross-links in the code of conduct, compliance, and security documentation.

Walkthrough

Three documentation files update their CONTRIBUTING.md links from the repository root to .github/CONTRIBUTING.md.

Changes

Documentation link updates

Layer / File(s) Summary
Update CONTRIBUTING.md references
CODE_OF_CONDUCT.adoc, RSR_COMPLIANCE.adoc, SECURITY.adoc
The “See also” links now point to .github/CONTRIBUTING.md.

Priority: ⬇️ Low

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

Change: Bug fix

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarises the main change: it updates documentation references to the relocated contributing guide.
Description check ✅ Passed The description directly explains the broken references, the new .github/CONTRIBUTING.md location, and all affected files.
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.

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 path with care
Three links now find the guide up there
No root trail leads them astray
The .github route shows the way
Hop, hop, done for today

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

@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath merged commit 9c5787f into main Sep 19, 2026
27 of 30 checks passed
@hyperpolymath
hyperpolymath deleted the refactor/contributing-guide-link-repair branch September 19, 2026 12:58
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