Skip to content

Fix CONTRIBUTING.md link - #1194

Open
dnicolson wants to merge 1 commit into
getkimchi:masterfrom
dnicolson:patch-1
Open

dnicolson wants to merge 1 commit into
getkimchi:masterfrom
dnicolson:patch-1

Conversation

@dnicolson

Copy link
Copy Markdown

No description provided.

@readme-ai-writer

readme-ai-writer Bot commented Sep 12, 2026

Copy link
Copy Markdown

📚 No documentation changes were needed for this PR.

@kimchi-review

kimchi-review Bot commented Sep 12, 2026

Copy link
Copy Markdown

Kimchi Code Review

Property Value
Commit 1df730f
Author @dnicolson
Files changed 1
Review status Completed
Comments 2 (1 info, 1 warning)
Duration 42s

Summary

📊 Review Score: 72/100 (overall code quality — 0 lowest, 100 highest)
⏱️ Estimated effort to review: 1/5 (1 = trivial, 5 = very complex)

🧪 Tests: no — No tests added, which is acceptable — the change is a single link edit in the GitHub PR template markdown file and has no executable behavior to test.

📝 Found 2 issue(s). See inline comments for details.

What to expect

Kimchi will analyze the changes in this pull request and post:

  • A summary of the overall changes
  • Inline comments on specific lines with findings categorized by issue type

The review typically completes within a few minutes. This comment will be updated once the review is ready.

Interact with Kimchi
  • @getkimchi review — re-trigger a full review on the latest commit
  • @getkimchi summary — regenerate the PR summary
  • @getkimchi ignore — skip this PR (no review will be posted)
  • Reply to any inline comment to ask follow-up questions or request clarification
Configuration

Reviews are configured by your organization admin.
Review instructions, excluded directories, and severity thresholds can be adjusted per repository in the Kimchi dashboard.


Powered by Kimchi — AI-powered code review by CAST AI

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Thanks for your first PR on kimchi! A maintainer will review it soon.
Please make sure your PR links to an open issue and your checklist is complete.

@kimchi-review kimchi-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📊 Review Score: 72/100 (overall code quality — 0 lowest, 100 highest)
⏱️ Estimated effort to review: 1/5 (1 = trivial, 5 = very complex)

🧪 Tests: no — No tests added, which is acceptable — the change is a single link edit in the GitHub PR template markdown file and has no executable behavior to test.

📝 Found 2 issue(s). See inline comments for details.


- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md) and agree to the CLA
- [ ] I have read [CONTRIBUTING.md](/CONTRIBUTING.md) and agree to the CLA
- [ ] This PR links to an open issue above

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️🐛 Bug

The root-relative link /CONTRIBUTING.md only works when GitHub renders the template as a repository file (blob view), where paths starting with / are rewritten relative to the repository root. When the template content is rendered inside an actual pull request description — the primary place contributors click this checklist link — GitHub does not rewrite relative or root-relative links in issue/PR bodies, so the browser resolves /CONTRIBUTING.md to https://github.com/CONTRIBUTING.md, which is a 404. The previous ../CONTRIBUTING.md was also broken in PR bodies, so this change does not actually fix the link where it is used.

💡 Suggestion: Use a fully-qualified URL so the link works in PR descriptions, comments, and rendered files alike: [CONTRIBUTING.md](https://github.com/getkimchi/kimchi/blob/master/CONTRIBUTING.md). Alternatively use https://github.com/getkimchi/kimchi/blob/HEAD/CONTRIBUTING.md to avoid pinning a branch name.


- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md) and agree to the CLA
- [ ] I have read [CONTRIBUTING.md](/CONTRIBUTING.md) and agree to the CLA
- [ ] This PR links to an open issue above

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️🔧 Maintainability

Switching from ../CONTRIBUTING.md to /CONTRIBUTING.md drops repo-relative resolution for anyone viewing the template outside GitHub (raw file view, git clone, or an editor markdown preview that resolves / against a filesystem or workspace root rather than the repository root). GitHub's own documentation recommends relative links specifically because they keep working in clones.

💡 Suggestion: If the absolute-URL suggestion above is not adopted, prefer keeping ../CONTRIBUTING.md for clone-friendliness, since both relative forms behave identically in GitHub's rendered file view.

Updated link format in pull request template.
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