Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (29 loc) · 889 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 889 Bytes

Contributing Guidelines

Development Setup

  1. Fork the repository
  2. Clone your fork
  3. Install dependencies: npm install
  4. Create a feature branch: git checkout -b feature/your-feature
  5. Make your changes
  6. Run tests: npm test
  7. Run linter: npm run lint
  8. Commit with meaningful messages
  9. Push and create a pull request

Code Style

  • Use TypeScript for type safety
  • Follow Next.js 14+ App Router conventions
  • Use CSS Modules for styling
  • Keep components modular and reusable
  • Add comments for complex logic

Commit Messages

Use clear, descriptive commit messages:

  • feat: Add new feature
  • fix: Fix bug in component
  • docs: Update documentation
  • style: Format code
  • refactor: Refactor component
  • test: Add tests

Testing

  • Write tests for utility functions
  • Test component behavior where applicable
  • Maintain test coverage above 80%