docs(rules): add nix-workflow rule #106
Conversation
- Add .claude/rules/nix-workflow.md with guidance on: - Using flake.nix with flake-parts for dev environment - Adding tools to buildInputs - Treefmt and git-hooks configuration - CI workflow with setup-nix action - Recommended build flags (--print-build-logs --show-trace) - Update CLAUDE.md to include nix-workflow in available rules table Based on stackone-ai-node's nix-workflow.md, adapted for Python SDK with flake-parts, treefmt-nix, and git-hooks.nix specifics.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for Nix workflow conventions to the Claude rules system. The new rule provides comprehensive guidance on using Nix for development environment setup and CI configuration.
Changes:
- Added new
.claude/rules/nix-workflow.mddocumenting Nix development environment setup, treefmt configuration, git hooks, and CI workflow - Updated CLAUDE.md to include nix-workflow in the available rules table
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .claude/rules/nix-workflow.md | New rule documenting Nix flake usage, development tools, CI configuration, and build flags |
| CLAUDE.md | Added nix-workflow entry to the Available Rules table |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,99 @@ | |||
| # Nix Workflow | |||
There was a problem hiding this comment.
Missing YAML frontmatter. All other rules in the .claude/rules/ directory have YAML frontmatter at the top of the file with description and alwaysApply fields. This frontmatter is used by Claude Code to understand when to apply the rule. Add frontmatter similar to other rules like:
---
description: Nix development environment and CI configuration. (project)
alwaysApply: true
---| ## Notes | ||
|
|
||
| - The project uses flake-parts for modular flake configuration | ||
| - Git submodules are initialised automatically in dev shell and CI |
There was a problem hiding this comment.
Inconsistent spelling. The project uses American English spelling (e.g., "organization", "organize" in CLAUDE.md and other files). Change "initialised" to "initialized" to maintain consistency.
| - Git submodules are initialised automatically in dev shell and CI | |
| - Git submodules are initialized automatically in dev shell and CI |
These flags are only needed for debugging and slow down normal builds.
Summary
.claude/rules/nix-workflow.mdwith guidance on Nix development environment and CI configurationCLAUDE.mdto include the new rule in the available rules tableDetails
Based on stackone-ai-node's nix-workflow.md, adapted for the Python SDK with:
Test plan
Summary by cubic
Add a nix-workflow rule detailing Nix dev environment and CI setup for the Python SDK (flake-parts, treefmt-nix, git-hooks, uv/ty/just, and setup-nix usage).
Update CLAUDE.md to include the new rule.
Written for commit a7762af. Summary will update on new commits.