diff --git a/.agents/skills/contribute-docs/SKILL.md b/.agents/skills/contribute-docs/SKILL.md index 7d8c761a2..ea4edbbf2 100644 --- a/.agents/skills/contribute-docs/SKILL.md +++ b/.agents/skills/contribute-docs/SKILL.md @@ -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` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 061c6def6..6f0b2faed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/docs/contribute/workflow-and-reviews.mdx b/docs/contribute/workflow-and-reviews.mdx index 5e97cbbe0..e42706c9c 100644 --- a/docs/contribute/workflow-and-reviews.mdx +++ b/docs/contribute/workflow-and-reviews.mdx @@ -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