diff --git a/CLAUDE.md b/CLAUDE.md index 4e73e8c..1fb1a83 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -15,6 +15,56 @@ Adopt-a-Street is a community street adoption platform with a React frontend and - Restructure the codebase for improved architecture - Make backward-incompatible changes that enhance the application +## Development Workflow + +**IMPORTANT: Commit to Git After Every Feature/Fix/Update** + +After implementing any feature, fix, or update, you MUST: + +1. **Build and test** the changes: + ```bash + # Backend + cd backend && npm test + + # Frontend + cd frontend && npm run build + ``` + +2. **Create a git commit** with a descriptive message: + ```bash + git add + git commit -m "feat/fix/docs: descriptive message + + Detailed explanation of changes... + + 🤖 Generated with [Claude Code](https://claude.com/claude-code) + + Co-Authored-By: Claude " + ``` + +3. **Use conventional commit prefixes**: + - `feat:` - New features + - `fix:` - Bug fixes + - `docs:` - Documentation changes + - `test:` - Test additions or updates + - `refactor:` - Code refactoring + - `chore:` - Maintenance tasks + - `perf:` - Performance improvements + +4. **Commit frequency**: Create commits for each logical unit of work. Don't batch multiple unrelated changes into one commit. + +5. **Push regularly**: Push commits to origin after completing features or at end of session: + ```bash + git push origin main + ``` + +This ensures: +- Clear history of all changes +- Easy rollback if needed +- Better collaboration and code review +- Deployment tracking +- CI/CD pipeline triggers + ## Architecture ### Monorepo Structure