Skip to content

docs: require issues before contribution PRs #343

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

Merged
rapids-bot merged 1 commit into from
Jul 2, 2026
Merged

docs: require issues before contribution PRs #343

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
1 change: 1 addition & 0 deletions .agents/skills/contribute-docs/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Use this skill for docs-only or example-heavy changes.

- Prefer the documented public API, not internal shortcuts
- Keep package names, repo references, and build commands current
- When documenting contribution workflow, require an issue before external contribution PRs and note that NVIDIA contributors may use a GitHub or Linear issue.
- Update entry-point docs when examples or reading paths change
- Keep release-process and release-notes guidance in repo-maintainer docs such as
`RELEASING.md`, not as user-facing docs pages or `CHANGELOG.md`
Expand Down
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,11 +214,12 @@ This section describes how to prepare and submit changes for review.

Complete these checks before opening or updating a pull request.

1. Ensure all pre-commit hooks pass.
2. Run the relevant test suites and confirm they pass.
3. Verify your changes compile cleanly with the relevant target-specific build recipe, such as `just build-rust` or `just build-python`.
4. Update the relevant documentation entry points and references.
5. Rebase your branch on the latest `main` to avoid merge conflicts.
1. Open or identify an issue describing the proposed enhancement or bug fix before submitting a pull request. External contributors should use a GitHub issue; NVIDIA contributors may use a GitHub or Linear issue.
2. Ensure all pre-commit hooks pass.
3. Run the relevant test suites and confirm they pass.
4. Verify your changes compile cleanly with the relevant target-specific build recipe, such as `just build-rust` or `just build-python`.
5. Update the relevant documentation entry points and references.
6. Rebase your branch on the latest `main` to avoid merge conflicts.

### PR Description

Expand Down
9 changes: 5 additions & 4 deletions docs/contribute/workflow-and-reviews.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ The configured hooks include a lightweight Markdown link check for

Before submitting a PR:

1. Ensure relevant hooks and tests pass.
2. Verify the workspace builds cleanly.
3. Update docs for public changes.
4. Rebase on the latest `main`.
1. Open or identify an issue describing the proposed enhancement or bug fix before submitting a PR. External contributors should use a GitHub issue; NVIDIA contributors may use a GitHub or Linear issue.
2. Ensure relevant hooks and tests pass.
3. Verify the workspace builds cleanly.
4. Update docs for public changes.
5. Rebase on the latest `main`.

## Release Tags

Expand Down
Loading