Skip to content

Add comprehensive codebase documentation (CLAUDE.md)#245

Open
xorpaul wants to merge 1 commit into
masterfrom
claude/claude-md-mltpi2lurum2mc3m-R40sl
Open

Add comprehensive codebase documentation (CLAUDE.md)#245
xorpaul wants to merge 1 commit into
masterfrom
claude/claude-md-mltpi2lurum2mc3m-R40sl

Conversation

@xorpaul

@xorpaul xorpaul commented Feb 19, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR adds a comprehensive developer guide (CLAUDE.md) that documents the g10k codebase structure, architecture, and development practices. This guide serves as a reference for developers working on the project and provides context for AI-assisted development.

Key Changes

  • New file: CLAUDE.md — A 381-line developer guide covering:
    • Project overview and key differentiators from r10k
    • Complete repository structure with file descriptions
    • Detailed documentation of all major source files and their responsibilities
    • Core data structures and their fields
    • Development workflow and build instructions
    • Testing patterns (config tests, crash tests, integration tests, HTTP mocks)
    • Code conventions (logging, error handling, concurrency, module installation modes)
    • CLI flags reference table
    • Quick lookup table for where to make specific changes
    • CI/CD pipeline documentation
    • Dependency reference

Notable Details

  • Includes practical examples of testing patterns used in the codebase (subprocess testing for fatal conditions, hashdeep integration tests, HTTP mocks)
  • Documents the strict naming convention for config tests (TestConfigXxxtests/TestConfigXxx.yaml)
  • Provides a comprehensive CLI flags reference with defaults and purposes
  • Explains the three module installation modes (hardlinks, move, clone) and their use cases
  • Documents the logging hierarchy and when each logging function should be used
  • Includes a "Where to Make Changes" quick reference table for common development tasks

This documentation improves developer onboarding and provides a single source of truth for codebase architecture and conventions.

https://claude.ai/code/session_01Xrzb4i425wBHwFutHicJd5

Documents codebase structure, all key source files and their functions,
major data structures, development workflow, testing patterns, code
conventions, CLI flags, and where to make changes for common tasks.

https://claude.ai/code/session_01Xrzb4i425wBHwFutHicJd5
@jay7x

jay7x commented Apr 30, 2026

Copy link
Copy Markdown
Member

I see no issue merging this. Just need to keep it up-to-date with changes we made in "old school manual way" :)

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.

3 participants