docs: add mandatory git commit workflow to development guidelines
Update CLAUDE.md to establish clear git workflow requirements: Workflow Requirements: - Commit to git after EVERY feature, fix, or update - Build and test changes before committing - Use conventional commit message format (feat, fix, docs, test, refactor, chore, perf) - Create commits for each logical unit of work - Push regularly to origin/main Benefits: - Clear history of all changes - Easy rollback capabilities - Better collaboration and code review - Deployment tracking - Automatic CI/CD pipeline triggers Commit Message Template: - Prefix: feat/fix/docs/test/refactor/chore/perf - Description: Clear, concise summary - Body: Detailed explanation of changes - Footer: Claude Code attribution This ensures the codebase maintains a clean, traceable history and enables better DevOps practices. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
50
CLAUDE.md
50
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
|
- Restructure the codebase for improved architecture
|
||||||
- Make backward-incompatible changes that enhance the application
|
- 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 <files>
|
||||||
|
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 <noreply@anthropic.com>"
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
## Architecture
|
||||||
|
|
||||||
### Monorepo Structure
|
### Monorepo Structure
|
||||||
|
|||||||
Reference in New Issue
Block a user