diff --git a/CLAUDE.md b/CLAUDE.md index dd117ae..a0a8f37 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -136,6 +136,46 @@ Comprehensive project documentation is available in the `/docs` folder: - `06-Repository-Skeleton.md` - Project structure reference - `07-Risk-Register.md` - Identified risks and mitigation strategies +## Git Workflow + +**IMPORTANT: Always use feature branches and Pull Requests - never push directly to main** + +### Development Workflow +1. **Create a new branch** for any changes: + ```bash + git checkout -b feature/your-feature-name + # or + git checkout -b fix/bug-description + # or + git checkout -b docs/documentation-update + ``` + +2. **Make your changes and commit**: + ```bash + git add . + git commit -m "descriptive commit message" + ``` + +3. **Push branch to GitHub**: + ```bash + git push -u origin feature/your-feature-name + ``` + +4. **Create Pull Request using GitHub CLI**: + ```bash + gh pr create --title "Your PR Title" --body "PR description" + ``` + +5. **Never push directly to main** - all changes must go through PR review + +### Branch Naming Convention +- `feat/` - New features +- `fix/` - Bug fixes +- `docs/` - Documentation updates +- `refactor/` - Code refactoring +- `test/` - Test additions/updates +- `chore/` - Maintenance tasks + ## Development Notes - PWA requires HTTPS for many features (File System Access, Web Push) @@ -144,4 +184,5 @@ Comprehensive project documentation is available in the `/docs` folder: - WebRTC requires STUN/TURN for NAT traversal - BLE pairing is optional enhancement (Chromium only) - **Package Manager**: Always use `yarn` for consistency across the project -- **Backend**: Use `Makefile` commands for all backend development tasks \ No newline at end of file +- **Backend**: Use `Makefile` commands for all backend development tasks +- **Git Identity**: Configured as `Anh Nguyen ` \ No newline at end of file