@obviousworks/vibe-coding-global-rules

# Global AI Coding Rules

## Core Principles
- **Simplicity First**: Always prefer the simplest solution that meets requirements
- **Readability**: Code should be self-documenting; prioritize clarity over cleverness
- **Consistency**: Follow established patterns within the project
- **DRY (Don't Repeat Yourself)**: Extract reusable logic into functions/modules

## Workflow Standards
- **Rule Application Tracking**: When applying rules, tag them with abbreviations (e.g., [SF] for Simplicity First)
- **Incremental Changes**: Make small, testable changes rather than large refactors
- **Documentation as You Go**: Update documentation when changing functionality
- **Test-Driven**: Write tests before or alongside implementation

## Code Quality Guarantees
- **Type Safety**: Use TypeScript/type hints; avoid `any` types
- **Error Handling**: Implement comprehensive error handling with clear messages
- **Logging**: Add appropriate logging for debugging and monitoring
- **Code Reviews**: All code should be review-ready with clear intent

## Security & Performance Considerations
- **Input Validation**: Validate all user inputs
- **Authentication & Authorization**: Implement proper access controls
- **Data Privacy**: Never log sensitive information
- **Performance**: Consider performance implications; profile when needed
- **Security Scanning**: Run security checks before deployment

## AI Communication Guidelines
- **Clarity**: Be explicit about requirements and constraints
- **Context**: Provide relevant background information
- **Verification**: Review AI-generated code carefully
- **Iteration**: Refine prompts based on initial results

## Continuous Documentation
- **Code Comments**: Explain 'why' not 'what'
- **README Updates**: Keep README current with project changes
- **API Documentation**: Document all public APIs
- **Changelog**: Maintain a changelog for significant updates

## Feature-Based Development Workflow
1. **Planning**: Define feature requirements and acceptance criteria
2. **Design**: Outline architecture and data models
3. **Implementation**: Code following established patterns
4. **Testing**: Write and run tests
5. **Review**: Code review and refinement
6. **Documentation**: Update relevant docs
7. **Deployment**: Deploy with monitoring