Skip to content

Move contributing.md to root #2119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aamijar wants to merge 1 commit into
base: release/26.06
Choose a base branch
from
+6 −6
Open

Move contributing.md to root #2119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .coderabbit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,5 @@ knowledge_base:
filePatterns:
- "cpp/REVIEW_GUIDELINES.md"
- "python/REVIEW_GUIDELINES.md"
- "docs/source/contributing.md"
- "docs/source/developer_guide.md"
- "CONTRIBUTING.md"
- "fern/pages/developer_guide.md"
2 changes: 1 addition & 1 deletion fern/pages/contributing.md → CONTRIBUTING.md
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ into three categories:

## 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.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 22, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
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.


### Your first issue

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ For more code examples of the Rust APIs, including a drop-in project templates,

## Contributing

If you are interested in contributing to the cuVS library, please read our [Contributing guidelines](docs/source/contributing.md). Refer to the [Developer Guide](docs/source/developer_guide.md) for details on the developer guidelines, workflows, and principles.
If you are interested in contributing to the cuVS library, please read our [Contributing guidelines](CONTRIBUTING.md). Refer to the [Developer Guide](fern/pages/developer_guide.md) for details on the developer guidelines, workflows, and principles.

## References

Expand Down
2 changes: 1 addition & 1 deletion fern/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ navigation:
- page: "Link-time Optimization"
path: "./pages/jit_lto_guide.md"
- page: "Contributing"
path: "./pages/contributing.md"
path: "../CONTRIBUTING.md"
- section: "API Reference"
contents:
- section: "C API Documentation"
Expand Down
2 changes: 1 addition & 1 deletion fern/pages/developer_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Use these pages when contributing to cuVS or working on integrations that need t

## Contributing

- [Contributing](contributing.md): learn how to set up a development environment, submit changes, and work with the project.
- [Contributing](/developer-guide/contributing): learn how to set up a development environment, submit changes, and work with the project.
Loading