Project Conventions

Overview

<!-- Brief description of the project -->

Tech Stack

<!-- List your technologies -->
- Language:
- Framework:
- Database:
- Testing:

Code Style

• Use consistent indentation (spaces/tabs)
• Follow language-specific naming conventions
• Keep functions under 50 lines when possible
• Document complex logic with comments

File Organization

<!-- Describe your project structure -->

Testing Requirements

• Write unit tests for business logic
• Integration tests for API endpoints
• Run tests before committing

Git Workflow

• Create feature branches
• Write descriptive commit messages
• Keep commits atomic and focused

Common Patterns

<!-- Document patterns specific to your project -->

Things to Avoid

• No hardcoded credentials
• Avoid global state
• Don't skip error handling