docs: add CONTRIBUTING.md#2579
Conversation
Codify the conventions established during the 2026-07 PR-backlog triage: scope contract for PRs, content/link/metadata conventions, generated-API-page workflow, and the patch/swizzle last-resort ladder. Seeded in part by conventions proposed in #1044. Refs #1044 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a repository-level CONTRIBUTING.md to codify project contribution expectations and documentation/site conventions (including PR scope, content/link rules, and generated API page workflows), based on the 2026-07 triage outcomes and proposals from #1044.
Changes:
- Introduces a comprehensive contributing guide covering PR hygiene, content conventions, and review expectations.
- Documents workflows/policies for generated API reference pages and for URL/redirect handling.
- Defines a “patch/swizzle as last resort” decision ladder for dependency issues.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Page metadata | ||
|
|
||
| - Sidebar ordering is declared with `sidebar_position` in each page's frontmatter. **Don't add `_category_.json` files.** |
|
Preview is available here: |
|
@claude review this PR |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Preview is available here: |
The rationale ("has changed before") was incorrect, so the ruling and
its TODO come out rather than getting confirmed.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview is available here: |
1 similar comment
|
Preview is available here: |
|
Preview is available here: |
Codify the conventions established during the 2026-07 PR-backlog triage: scope contract for PRs, content/link/metadata conventions, generated-API-page workflow, and the patch/swizzle last-resort ladder. Seeded in part by conventions proposed in #1044.
Refs #1044