Skip to content

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

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.

  • .github/CONTRIBUTING.md: in-guide links withdrawn one level to the root
  • QUICKSTART-DEV.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.

- `.github/CONTRIBUTING.md`: in-guide links withdrawn one level to the root
- `QUICKSTART-DEV.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: 0ea91767-73b3-4610-9dda-2caee31d69d4

📥 Commits

Reviewing files that changed from the base of the PR and between d88c3e0 and b395eab.

📒 Files selected for processing (2)
  • .github/CONTRIBUTING.md
  • QUICKSTART-DEV.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. (16)
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / shell-secrets
  • GitHub Check: scan / gitleaks
  • GitHub Check: Julia 1.11 - ubuntu-latest
  • GitHub Check: Julia 1.10 - ubuntu-latest
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: Julia 1.11 - macos-latest
  • GitHub Check: governance / Security policy checks
🧰 Additional context used
🪛 LanguageTool
.github/CONTRIBUTING.md

[locale-violation] ~82-~82: License must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: .../CODE_OF_CONDUCT.adoc) for details. ## License By contributing, you agree that your c...

(LICENCE_LICENSE_NOUN_SINGULAR)


[locale-violation] ~85-~85: license must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: ...butions will be licensed under the same license as the project (see [LICENSE](../LICENS...

(LICENCE_LICENSE_NOUN_SINGULAR)


[locale-violation] ~85-~85: LICENSE must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: ...r the same license as the project (see LICENSE).

(LICENCE_LICENSE_NOUN_SINGULAR)

🔇 Additional comments (2)
.github/CONTRIBUTING.md (1)

80-80: LGTM!

Also applies to: 85-85

QUICKSTART-DEV.adoc (1)

41-41: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Corrected links in the contributing guidelines to the repository’s code of conduct and licence files.
    • Updated the developer quickstart to link to the contributing guidelines in their current location.

Walkthrough

The changes correct relative links in the contribution guidelines and developer quickstart. The links now point to the repository locations of CODE_OF_CONDUCT.adoc, LICENSE, and .github/CONTRIBUTING.md.

Changes

Documentation link corrections

Layer / File(s) Summary
Correct repository documentation paths
.github/CONTRIBUTING.md, QUICKSTART-DEV.adoc
The contribution guidelines use parent-directory paths for the code of conduct and licence. The developer quickstart points to .github/CONTRIBUTING.md.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation link updates caused by the relocated contributing guide.
Description check ✅ Passed The description accurately explains the relocation to .github/CONTRIBUTING.md and identifies both corrected references.
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 checked each path with care
The links now hop from here to there
The conduct guide points up the tree
The quickstart finds its .github key
Clean paths greet the hare with glee

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

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