Conversation
|
📚 No documentation changes were needed for this PR. |
Kimchi Code Review
Summary📊 Review Score: 72/100 (overall code quality — 0 lowest, 100 highest) 🧪 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 expectKimchi will analyze the changes in this pull request and post:
The review typically completes within a few minutes. This comment will be updated once the review is ready. Interact with Kimchi
ConfigurationReviews are configured by your organization admin. Powered by Kimchi — AI-powered code review by CAST AI |
There was a problem hiding this comment.
📊 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
ℹ️🔧 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.
No description provided.