Project Guidelines

Overview

Brief description of what this project does and its main purpose.

Tech Stack

• Language: [Your language]
• Framework: [Your framework]
• Database: [Your database]
• Key Libraries: [Important dependencies]

Project Structure

src/
├── components/    # Reusable UI components
├── services/      # Business logic
├── models/        # Data models
└── utils/         # Helper functions

Development Commands

# Install dependencies
npm install

# Run development server
npm run dev

# Run tests
npm test

# Run linter
npm run lint

Code Style

• Follow the existing patterns in the codebase
• Use meaningful variable and function names
• Keep functions small and focused
• Write self-documenting code; add comments only when the why isn't obvious

Testing

• Write tests for new features and bug fixes
• Run the full test suite before committing
• Aim for meaningful test coverage, not just high percentages

Git Workflow

• Create feature branches from main
• Write clear, concise commit messages
• Keep commits atomic and focused

Important Notes

• Never commit secrets or API keys
• Check for security vulnerabilities in dependencies
• Follow the principle of least privilege