Skip to content

Add project documentation (ARCHITECTURE, CONTRIBUTING, CLAUDE)#177

Draft
laurahuysamen wants to merge 2 commits intomainfrom
claude-init
Draft

Add project documentation (ARCHITECTURE, CONTRIBUTING, CLAUDE)#177
laurahuysamen wants to merge 2 commits intomainfrom
claude-init

Conversation

@laurahuysamen
Copy link
Contributor

Summary

  • Add ARCHITECTURE.md with system context diagram, connection lifecycle sequence diagram, component breakdown, dependency table, and architectural principles
  • Add CONTRIBUTING.md with prerequisites, build/test commands, code style guidelines, branch naming conventions, PR process, and release workflow
  • Add CLAUDE.md with quick-reference commands, directory structure overview, key patterns/conventions, domain terminology glossary, and common pitfalls — cross-references the other two docs to avoid duplication

Test plan

  • Verify all file references in the docs point to existing files
  • Verify Mermaid diagrams render correctly on GitHub
  • Review content accuracy against codebase

Add ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to provide
structured guidance for developers and AI assistants working in
this repository.
@laurahuysamen laurahuysamen requested a review from a team as a code owner March 5, 2026 11:44
@laurahuysamen laurahuysamen marked this pull request as draft March 5, 2026 13:05
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.

1 participant