Skip to content

Add developer documentation#17

Merged
manavgup merged 1 commit into
mainfrom
docs/developer-documentation
Apr 6, 2026
Merged

Add developer documentation#17
manavgup merged 1 commit into
mainfrom
docs/developer-documentation

Conversation

@manavgup
Copy link
Copy Markdown
Owner

@manavgup manavgup commented Apr 6, 2026

Summary

  • DEVELOPING.md — setup, project structure, how code generation works, CLI commands, file ownership
  • TESTING.md — test organization, markers, coverage, patterns (async, fakes, CLI, templates, generated projects)
  • CONTRIBUTING.md — workflow, code standards, CI checks, commit/PR conventions
  • CLAUDE.md — updated commands and references to new docs

Closes #14

Test plan

  • Docs render correctly on GitHub
  • make check passes (no code changes)
  • A new contributor can set up the project using only DEVELOPING.md

🤖 Generated with Claude Code

- DEVELOPING.md: setup, project structure, how code generation works,
  CLI commands, file ownership model, key design decisions
- TESTING.md: test organization, markers, coverage, patterns for async
  tests, fake repos, CLI tests, template tests, generated project tests
- CONTRIBUTING.md: workflow, code standards, CI checks, commit/PR
  conventions, architecture decisions
- CLAUDE.md: update common commands and add references to new docs

Closes #14

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@manavgup manavgup merged commit 9b93a7c into main Apr 6, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add developer documentation (DEVELOPING.md, TESTING.md, CONTRIBUTING.md)

1 participant