Skip to content

Commit 4b1d293

Browse files
authored
Merge pull request #86 from Miyamura80/chore/improve-agent-readiness
🏗️ improve agent readiness with skills and devcontainer
2 parents d379a76 + 97c1879 commit 4b1d293

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

.claude/skills/code-quality.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Code Quality Skill
2+
3+
This skill provides instructions for running code quality checks and maintaining standards in the Python-Template project.
4+
5+
## Commands
6+
7+
Use the following `make` targets to ensure code quality:
8+
9+
- `make fmt`: Runs the `ruff` formatter and formats JSON files.
10+
- `make ruff`: Runs the `ruff` linter to catch common errors and style issues.
11+
- `make vulture`: Searches for dead code across the project.
12+
- `make ty`: Runs the `ty` type checker to ensure type safety.
13+
- `make ci`: Runs all of the above checks (`ruff`, `vulture`, `import_lint`, `ty`, `docs_lint`, `check_deps`) in sequence.
14+
15+
## Workflow
16+
17+
1. **Before Committing**: Always run `make fmt` and `make ruff`.
18+
2. **Major Changes**: Run `make ci` to ensure no regressions in types or dead code.
19+
3. **Continuous Integration**: These checks are enforced in the CI pipeline. Ensure all pass before opening a PR.

.devcontainer/devcontainer.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "Python-Template DevContainer",
3+
"image": "mcr.microsoft.com/devcontainers/python:3.12-bookworm",
4+
"features": {
5+
"ghcr.io/devcontainers/features/common-utils:1": {
6+
"configureZsh": true
7+
}
8+
},
9+
"customizations": {
10+
"vscode": {
11+
"extensions": [
12+
"charliermarsh.ruff",
13+
"ms-python.python",
14+
"ms-python.vscode-pylance",
15+
"tamasfe.even-better-toml",
16+
"mkhl.direnv"
17+
],
18+
"settings": {
19+
"python.defaultInterpreterPath": ".venv/bin/python",
20+
"python.testing.pytestEnabled": true,
21+
"python.testing.pytestArgs": [
22+
"tests"
23+
],
24+
"[python]": {
25+
"editor.formatOnSave": true,
26+
"editor.defaultFormatter": "charliermarsh.ruff"
27+
}
28+
}
29+
}
30+
},
31+
"postCreateCommand": "curl -LsSf https://astral.sh/uv/install.sh | sh && . $HOME/.cargo/env && make setup",
32+
"remoteUser": "vscode"
33+
}

0 commit comments

Comments
 (0)