86 lines
2.3 KiB
Markdown
86 lines
2.3 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
**testproject** - testproject
|
|
|
|
## ⚠️ CRITICAL: Updating Todos, Milestones, and Goals
|
|
|
|
**DO NOT edit `todos.md`, `milestones.md`, or `goals.md` files directly.**
|
|
|
|
These files are managed by Development Hub which has file watchers and sync logic. Direct edits will be overwritten or cause conflicts.
|
|
|
|
**Use the `devhub-tasks` CLI instead:**
|
|
|
|
```bash
|
|
# Status overview
|
|
devhub-tasks status testproject
|
|
|
|
# Add todos
|
|
devhub-tasks todo add testproject "Task description" --priority high --milestone M1
|
|
|
|
# Complete todos (by text match or ID number)
|
|
devhub-tasks todo complete testproject "Task description"
|
|
devhub-tasks todo complete testproject 3
|
|
|
|
# List todos
|
|
devhub-tasks todo list testproject
|
|
|
|
# Add milestones
|
|
devhub-tasks milestone add testproject M2 --name "Milestone Name" --target "March 2026"
|
|
|
|
# Complete milestones (also completes linked todos)
|
|
devhub-tasks milestone complete testproject M1
|
|
|
|
# Goals
|
|
devhub-tasks goal add testproject "Goal description" --priority high
|
|
devhub-tasks goal complete testproject "Goal description"
|
|
```
|
|
|
|
Use `--json` flag for machine-readable output. Run `devhub-tasks --help` for full documentation.
|
|
|
|
**Files you CAN edit directly:** `overview.md`, `architecture.md`, `README.md`, and any other docs.
|
|
|
|
## Development Commands
|
|
|
|
```bash
|
|
# Install for development
|
|
pip install -e ".[dev]"
|
|
|
|
# Run tests
|
|
pytest
|
|
|
|
# Run a single test
|
|
pytest tests/test_file.py::test_name
|
|
```
|
|
|
|
## Architecture
|
|
|
|
*TODO: Describe the project architecture*
|
|
|
|
### Key Modules
|
|
|
|
*TODO: List key modules and their purposes*
|
|
|
|
### Key Paths
|
|
|
|
- **Source code**: `src/testproject/`
|
|
- **Tests**: `tests/`
|
|
- **Documentation**: `docs/` (symlink to project-docs)
|
|
|
|
## Documentation
|
|
|
|
Documentation lives in `docs/` (symlink to centralized docs system).
|
|
|
|
**Before updating docs, read `docs/updating-documentation.md`** for full details on visibility rules and procedures.
|
|
|
|
Quick reference:
|
|
- Edit files in `docs/` folder
|
|
- Use `public: true` frontmatter for public-facing docs
|
|
- Use `<!-- PRIVATE_START -->` / `<!-- PRIVATE_END -->` to hide sections
|
|
- Deploy: `~/PycharmProjects/project-docs/scripts/build-public-docs.sh testproject --deploy`
|
|
|
|
Do NOT create documentation files directly in this repository.
|