diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..7a65d48 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,66 @@ +# CLAUDE.md — LearningCC + +This file provides guidance for AI assistants (Claude, etc.) working in this repository. + +## Project Overview + +**LearningCC** is a starter/learning repository. It is currently in its initial state with no source code, dependencies, or build tooling configured yet. + +## Repository Structure + +``` +LearningCC/ +├── CLAUDE.md # AI assistant guidance (this file) +└── README.md # Project description +``` + +## Current State + +- **Language/Framework:** Not yet chosen +- **Dependencies:** None +- **Build system:** None +- **Tests:** None +- **CI/CD:** None +- **Linting/Formatting:** None + +## Development Guidelines + +When adding code to this repository, follow these conventions: + +### General + +- Keep the repository well-organized with clear directory structure +- Add a `.gitignore` appropriate to the chosen language/framework +- Include meaningful commit messages that explain *why*, not just *what* + +### When Setting Up the Project + +1. Choose a language and framework, then add the appropriate config files +2. Set up a package manager and declare dependencies +3. Add linting and formatting tools from the start +4. Configure a test framework and write tests alongside new code +5. Add CI/CD pipeline configuration (e.g., GitHub Actions) +6. Update this CLAUDE.md file as the project evolves + +### Code Quality + +- Write clean, readable code with self-documenting names +- Keep functions small and focused on a single responsibility +- Validate inputs at system boundaries (user input, external APIs) +- Avoid premature abstraction — prefer simple, direct code + +### Testing + +- Write tests for new functionality +- Run the full test suite before committing +- Maintain test coverage as the project grows + +## Updating This File + +As the project develops, update this file to reflect: + +- Chosen tech stack and architecture decisions +- How to build, test, and run the project +- Key commands (build, test, lint, format, deploy) +- Important patterns and conventions adopted +- Environment setup requirements