diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md index 0b5b6c9..244090a 100644 --- a/.claude/CLAUDE.md +++ b/.claude/CLAUDE.md @@ -1,3 +1,58 @@ -# Claude Code Configuration +# Repository name - Claude Code Configuration -TODO: see https://bitwarden.atlassian.net/wiki/x/LgDMaQ for configuration tips to complete the `.claude/CLAUDE.md` file + + +Brief description of the project and its primary purpose. + +## Overview + +What this project does, key concepts, and target consumers. + +## Architecture & Patterns + +System architecture, code organization, key principles, and core patterns. + +## Development Guide + +Step-by-step instructions for the most common development tasks. + +## Data Models + +Core types and validation schemas. + +## Security & Configuration + +Security rules, environment configuration, and authentication. + +## Testing + +Test structure, writing tests, and running tests. + +## Code Style & Standards + +Formatting, naming conventions, and pre-commit hooks. + +## Anti-Patterns + +DO and DON'T lists. + +## Deployment + +Building, versioning, and publishing. + +## Troubleshooting + +Common issues and debug tips. + +## References + +Official documentation, internal documentation, and tools. diff --git a/README.md b/README.md index 99e2578..83afa40 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,35 @@ -# Template Repository +# Repository name -This repository serves as a template for others and establishes very basic structure and tooling setup for later customization. + + +One or two sentences stating what this repository is and which products or systems it serves. + +## Getting started + +Build instructions and environment setup live in the +[contributing documentation](https://contributing.bitwarden.com/getting-started/). + + + +## Structure + + + +| Container or component | Purpose | +| ---------------------- | ------- | +| | | + +## Related repositories + +- [bitwarden/server](https://github.com/bitwarden/server) — replace with the repos this one interacts with + +## Git hooks Hooks are centrally configured for the repo in the `.gitconfig` file. The `pre-commit` hook ([`.githooks/pre-commit`](.githooks/pre-commit)) runs [Prettier](https://prettier.io) (`--check`) on @@ -20,10 +47,12 @@ git config set --local include.path "../.gitconfig" Running the hook requires [Node.js](https://nodejs.org) (>=18); the tools are fetched on demand via `npx`. -## Customizing the linter +