Skip to content

Commit 40ad7eb

Browse files
committed
docs(claude): update CLAUDE.md with rules structure and table
Update CLAUDE.md to document the new rules and skills structure, matching the Node SDK's format. Changes: - Add rules/skills structure explanation section - Add table of available rules with their glob patterns - Update references to use rule names instead of file paths - Use UK English spelling (behaviour, organisation)
1 parent e260b5d commit 40ad7eb

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

CLAUDE.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,23 @@
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5-
## Cursor Rules
5+
## Rules and Skills Structure
66

7-
- @./.cursor/rules/package-installation
8-
- @./.cursor/rules/no-relative-imports
9-
- @./.cursor/rules/uv-scripts
10-
- @./.cursor/rules/release-please-standards
11-
- @./.cursor/rules/examples-standards
7+
- **Rules** (`.claude/rules/`): Automatically loaded based on file paths. Source of truth for project conventions.
8+
- **Skills** (`.claude/skills/`): Manually invoked for specific integrations.
9+
- **Cursor rules** (`.cursor/rules/`): Symlinks to `.claude/rules/` for consistency.
10+
11+
## Available Rules
12+
13+
| Rule | Applies To | Description |
14+
| ---------------------------- | ------------------- | -------------------------------------------------- |
15+
| **git-workflow** | All files | Commit conventions, branch strategy, PR guidelines |
16+
| **development-workflow** | All files | Code style, file naming, project conventions |
17+
| **release-please-standards** | All files | Release versioning with release-please |
18+
| **no-relative-imports** | `**/*.py` | Enforce absolute imports in Python files |
19+
| **package-installation** | `**/pyproject.toml` | UV package management standards |
20+
| **uv-scripts** | `scripts/**/*.py` | Utility script standards with UV |
21+
| **examples-standards** | `examples/**/*` | Example requirements and organisation |
1222

1323
## Project Overview
1424

@@ -85,11 +95,11 @@ toolset = StackOneToolSet(
8595

8696
- Snapshot testing for tool parsing (`tests/snapshots/`)
8797
- Async tests use `pytest-asyncio`
88-
- Example validation: See @./.cursor/rules/examples-standards
98+
- See `examples-standards` rule for example validation
8999

90100
## Important Considerations
91101

92-
1. **Dependencies**: See @./.cursor/rules/package-installation for uv dependency management
102+
1. **Dependencies**: See `package-installation` rule for uv dependency management
93103
2. **Pre-commit**: Hooks configured for ruff and mypy - run on all commits
94104
3. **Python Version**: Requires Python >=3.11
95105
4. **Error Handling**: Custom exceptions (`StackOneError`, `StackOneAPIError`)
@@ -104,7 +114,7 @@ toolset = StackOneToolSet(
104114
2. Parser automatically converts to tool definitions
105115
3. Test with `make test-tools`
106116

107-
### Modifying Tool Behavior
117+
### Modifying Tool Behaviour
108118

109119
- Core execution logic in `StackOneTool.execute()` method
110120
- HTTP configuration via `ExecuteConfig` class

0 commit comments

Comments
 (0)