Skip to content

Commit e865499

Browse files
nanotaboadaclaude
andcommitted
docs(claude): fix stale refs, add missing structure entries, trim redundancy
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 48c9b7c commit e865499

2 files changed

Lines changed: 11 additions & 25 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ This project uses famous football coaches as release codenames, following an A-Z
4646

4747
### Changed
4848

49+
- `CLAUDE.md`: fix stale `docker-compose.yml` reference to `compose.yaml`; add
50+
`rest/` and `gunicorn.conf.py` to Structure section; condense "Creating
51+
Issues" templates from 18 lines to 4 lines; remove redundant commit format
52+
block from "After completing work"
4953
- `routes/player_route.py`: explicitly document `422 Unprocessable Entity` for
5054
payload validation errors on POST and PUT endpoints — added `responses={422:
5155
...}` to route decorators (OpenAPI schema) and `Raises:` entries to

CLAUDE.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ databases/ — async SQLAlchemy session setup + get_database_url()
3636
models/ — Pydantic models for request/response validation
3737
scripts/ — shell scripts for Docker (entrypoint.sh, healthcheck.sh)
3838
tools/ — legacy standalone seed scripts (superseded by Alembic migrations)
39+
rest/ — HTTP request file (players.rest) for manual API testing
40+
gunicorn.conf.py — production WSGI worker config (used by Docker entrypoint)
3941
tests/ — pytest integration tests
4042
```
4143

@@ -174,7 +176,7 @@ Never suggest a release tag with a coach name not on this list.
174176
request/response models; discuss the rationale before restructuring
175177
- Dependencies (`pyproject.toml` with PEP 735 dependency groups)
176178
- CI/CD configuration (`.github/workflows/`)
177-
- Docker setup (`Dockerfile`, `docker-compose.yml`, `scripts/`)
179+
- Docker setup (`Dockerfile`, `compose.yaml`, `scripts/`)
178180
- Breaking API contract changes (field renames, type changes, removing fields)
179181
- Global error handling middleware
180182
- HTTP status codes assigned to existing error conditions
@@ -188,22 +190,10 @@ Never suggest a release tag with a coach name not on this list.
188190

189191
### Creating Issues
190192

191-
This project uses Spec-Driven Development (SDD): discuss in Plan mode first, create a GitHub Issue as the spec artifact, then implement. Always offer to draft an issue before writing code.
193+
Spec-Driven Development (SDD): discuss in Plan mode first, create a GitHub Issue as the spec artifact, then implement. Always offer to draft an issue before writing code.
192194

193-
**Feature request** (`enhancement` label):
194-
- **Problem**: the pain point being solved
195-
- **Proposed Solution**: expected behavior and functionality
196-
- **Suggested Approach** *(optional)*: implementation plan if known
197-
- **Acceptance Criteria**: at minimum — behaves as proposed, tests added/updated, no regressions
198-
- **References**: related issues, docs, or examples
199-
200-
**Bug report** (`bug` label):
201-
- **Description**: clear summary of the bug
202-
- **Steps to Reproduce**: numbered, minimal steps
203-
- **Expected / Actual Behavior**: one section each
204-
- **Environment**: runtime versions + OS
205-
- **Additional Context**: logs, screenshots, stack traces
206-
- **Possible Solution** *(optional)*: suggested fix or workaround
195+
- Feature (`enhancement`): Problem → Proposed Solution → Acceptance Criteria → References
196+
- Bug (`bug`): Description → Steps to Reproduce → Expected/Actual Behavior → Environment
207197

208198
### Key workflows
209199

@@ -218,15 +208,7 @@ migration → review and adjust the generated file in `alembic/versions/` →
218208
run `uv run alembic upgrade head` → update `models/player_model.py` if the
219209
API shape changes → update services and tests → run `pytest`.
220210

221-
**After completing work**: Propose a branch name and commit message for user
222-
approval. Do not create a branch, commit, or push until the user explicitly
223-
confirms. Commit message format:
224-
225-
```text
226-
feat(scope): description (#issue)
227-
228-
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
229-
```
211+
**After completing work**: Propose a branch name and commit message for user approval. Do not create a branch, commit, or push until the user explicitly confirms.
230212

231213
## Invariants (never change without explicit discussion)
232214

0 commit comments

Comments
 (0)