Skip to content

Add CLAUDE.md for Claude Code guidance#314

Open
bestian wants to merge 1 commit intoberkmancenter:stagingfrom
audreyt:add-claude-ai-dev-support
Open

Add CLAUDE.md for Claude Code guidance#314
bestian wants to merge 1 commit intoberkmancenter:stagingfrom
audreyt:add-claude-ai-dev-support

Conversation

@bestian
Copy link
Contributor

@bestian bestian commented Feb 26, 2026

Adds a CLAUDE.md file at the repo root to provide Claude Code with project-specific context: tech stack, directory structure, local dev setup commands, testing instructions, CI/CD overview, code conventions, key entry points, and third-party service notes.

What is in this PR?

This PR introduces a CLAUDE.md file at the repository root.

The goal is to provide structured, project-specific context to Claude Code so that AI-assisted development can better understand:

  • The overall architecture and technology stack
  • How to run and test the project locally
  • CI/CD workflows and deployment expectations
  • Coding conventions and project standards
  • Key entry points and important directories
  • External services and integration notes

Claude Code is currently primarily used in the audreyt:i18n-2026-neo branch for automated translation workflows. In the future, it can also support other engineering tasks such as refactoring, documentation generation, test scaffolding, and CI-related updates.

Changes in the codebase

  • Adds a new CLAUDE.md file at the repository root.

  • Documents:

    • Tech stack and architectural overview
    • Directory structure
    • Local development setup commands
    • Testing instructions
    • CI/CD overview
    • Code conventions and formatting guidelines
    • Key entry points and important modules
    • Third-party services and environment requirements
  • No functional application logic changes.

Changes outside the codebase

  • No infrastructure or database changes.
  • No external service configuration changes.
  • This PR only improves AI-assisted development workflow by supplying structured project metadata.

Testing this PR

  1. Checkout this branch.

  2. Confirm that CLAUDE.md exists at the repository root.

  3. Review the document for accuracy and completeness.

  4. (Optional) Use Claude Code in the audreyt:i18n-2026-neo branch to verify that:

    • The AI correctly interprets project structure.
    • Automated translation tasks run with improved contextual awareness.
    • Generated changes align with documented conventions.

Additional information

This PR does not alter runtime behavior.

The purpose is to make AI collaboration more predictable and aligned with project conventions. By centralizing project knowledge in CLAUDE.md, we reduce ambiguity, improve consistency in automated changes, and make future AI-assisted engineering tasks safer and more maintainable.

Adds a CLAUDE.md file at the repo root to provide Claude Code with
project-specific context: tech stack, directory structure, local dev
setup commands, testing instructions, CI/CD overview, code conventions,
key entry points, and third-party service notes.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@bestian bestian mentioned this pull request Feb 26, 2026
@mikewillems mikewillems self-requested a review March 5, 2026 21:09
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