Move contributing.md to root#2119
Conversation
aamijar
added
doc
📝 WalkthroughWalkthroughDocumentation paths are consolidated across the repository. Contributing guidance moves from ChangesDocumentation path consolidation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 23: Replace the repository-file link
"fern/pages/cpp_guidelines.md#performance-benchmarking" in CONTRIBUTING.md with
the published Developer Guide docs route (use the site/docs route format rather
than a repo path); update the link target to the corresponding docs URL (for
example the Developer Guide/performance-benchmarking anchor) so the sentence
"proper benchmarks" points to the live docs route instead of the source file
path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: d05d72de-bfd0-4295-ac57-822058f1cd69
📒 Files selected for processing (5)
.coderabbit.yamlCONTRIBUTING.mdREADME.mdfern/docs.ymlfern/pages/developer_guide.md
| ## Code contributions | ||
|
|
||
| Performance-critical changes require [proper benchmarks](cpp_guidelines.md#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule. | ||
| Performance-critical changes require [proper benchmarks](fern/pages/cpp_guidelines.md#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule. |
There was a problem hiding this comment.
Use docs-route link instead of repository file path.
This link targets a source file path (fern/pages/...) rather than the published Developer Guide route, which can break or degrade navigation when CONTRIBUTING.md is rendered in Fern docs.
Suggested fix
-Performance-critical changes require [proper benchmarks](fern/pages/cpp_guidelines.md#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule.
+Performance-critical changes require [proper benchmarks](/developer-guide/coding-guidelines/cpp-guidelines#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Performance-critical changes require [proper benchmarks](fern/pages/cpp_guidelines.md#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule. | |
| Performance-critical changes require [proper benchmarks](/developer-guide/coding-guidelines/cpp-guidelines#performance-benchmarking). Pull requests that affect performance-critical paths will not be merged until those benchmarks are produced; there are no exceptions to this rule. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` at line 23, Replace the repository-file link
"fern/pages/cpp_guidelines.md#performance-benchmarking" in CONTRIBUTING.md with
the published Developer Guide docs route (use the site/docs route format rather
than a repo path); update the link target to the corresponding docs URL (for
example the Developer Guide/performance-benchmarking anchor) so the sentence
"proper benchmarks" points to the live docs route instead of the source file
path.
|
@aamijar I don't believe we can move it like this. Instead, let's just link to the contributing guide in the docs from a different contributing.md. I'm honestly not concerned with what cuopt is doing. We dont need to repeat others. |
|
Hi @cjnolet, it worked fine for me when I built the fern docs and viewed them locally. All the links resolve fine. |
|
@aamijar I hate to break it to you but you can't link to pages outside of fern/pages. It won't deploy that way. Let's move the contributor guide back into the docs and create a new file in the root that just links to corresponding page in the docs. We don't need this duplicated in multiple places. |
2 participants
Move
CONTRIBUTING.mdto the root of the repo so that it appears as a separate tab next to readme on github. It should also appear in the sidebar on github. Other libraries like https://github.com/NVIDIA/cuopt do this too.This PR also fixes a couple of broken links in the readme due to the recent fern docs update.