docs: contributing guidelines and AI assistant instructions#354
Conversation
There was a problem hiding this comment.
Pull request overview
Adds contributor and assistant-facing documentation to standardize development workflow, code style, and commit conventions for the parallel-disk-usage repository.
Changes:
- Introduces
CONTRIBUTING.mdwith commit message conventions, Rust code style guidelines, and local/CI check instructions. - Adds
CLAUDE.mdand.github/copilot-instructions.mdto direct assistants to followCONTRIBUTING.md, with a short quick-reference section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | New contributor guide covering conventions and validation workflow. |
| CLAUDE.md | Claude-specific instructions pointing to CONTRIBUTING + quick reference. |
| .github/copilot-instructions.md | Copilot-specific instructions pointing to CONTRIBUTING + quick reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Performance Regression Reportscommit: 075ab09 There are no regressions. |
Ensures CLAUDE.md, AGENTS.md, and .github/copilot-instructions.md stay in sync (identical content after the title line). https://claude.ai/code/session_0118JGKVwhgbK8NwHfrorHfx
There was a problem hiding this comment.
Pull request overview
Adds contributor and AI-tooling guidance, and enforces that the repository’s AI instruction documents remain synchronized.
Changes:
- Introduces
CONTRIBUTING.mddocumenting commit conventions, Rust style conventions, and local/CI check commands. - Adds three AI instruction files (Claude, agents, Copilot) with a shared quick reference.
- Adds an integration test ensuring the AI instruction files stay in sync (excluding the title line).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
tests/sync_ai_instructions.rs |
New test to compare instruction file bodies for exact sync. |
CONTRIBUTING.md |
New contributor guide codifying conventions and how to run checks. |
CLAUDE.md |
New Claude-specific instruction entrypoint pointing to CONTRIBUTING.md. |
AGENTS.md |
New generic AI agent instructions matching CLAUDE.md content. |
.github/copilot-instructions.md |
New Copilot instructions matching the other AI instruction files. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
- Add `Hash` to derive order in quick reference (all AI instruction files) - Add `DOC=true` to the test command in CONTRIBUTING.md and AI instruction files - Clarify `unwrap()` rule: acceptable in tests and provably infallible operations - Unify titles to "AI Instructions" across all three files - Simplify sync test by removing `strip_title` (titles are now identical) https://claude.ai/code/session_0118JGKVwhgbK8NwHfrorHfx
Ensures `include_str!` in the sync test compiles even from a packaged crate. https://claude.ai/code/session_0118JGKVwhgbK8NwHfrorHfx
This reverts commit 7dcfdd6.
There was a problem hiding this comment.
Pull request overview
Adds contributor and AI-agent guidance documentation to the repo, plus a test to ensure the various AI instruction files remain identical over time.
Changes:
- Add
CONTRIBUTING.mddocumenting commit conventions, Rust style conventions, and local/CI checks. - Add synchronized AI instruction files (
CLAUDE.md,AGENTS.md,.github/copilot-instructions.md) pointing contributors/agents toCONTRIBUTING.md. - Add an integration test to verify the AI instruction files stay in sync.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
tests/sync_ai_instructions.rs |
New test asserting the three AI instruction files are identical. |
CONTRIBUTING.md |
New contribution guidelines (commit format, style, checks). |
CLAUDE.md |
New AI instruction “quick reference” (intended to match the other instruction files). |
AGENTS.md |
Same AI instruction content as CLAUDE.md. |
.github/copilot-instructions.md |
Same AI instruction content as CLAUDE.md for Copilot. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Without the flag, components install for the default toolchain rather than the one pinned in rust-toolchain. https://claude.ai/code/session_0118JGKVwhgbK8NwHfrorHfx
Summary
This PR establishes comprehensive contributing guidelines and development standards for the project, along with quick-reference instructions for AI assistants.
Changes
Details
These documents establish clear expectations for:
whereclauses, derive ordering)unwrap()in non-test code)test.shwith multiple feature combinations)https://claude.ai/code/session_0118JGKVwhgbK8NwHfrorHfx