Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (41 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

57 lines (41 loc) · 1.05 KB

Contributing to Boilerbase

Thanks for your interest in contributing! Here's how you can help.

Development Process

  1. Fork the repository
  2. Clone your fork
  3. Create a new branch
  4. Make your changes
  5. Run tests and linting
  6. Commit changes
  7. Push to your fork
  8. Submit a Pull Request

Pull Request Guidelines

  • Use a clear, descriptive title
  • Include relevant tests
  • Update documentation if needed
  • Follow existing code style
  • One feature/fix per PR

Setting Up Local Development

# Install dependencies
npm install

# Set up environment
cp .env.example .env.local

# Run development server
npm run dev

Code Style

  • Use TypeScript
  • Follow ESLint rules
  • Write descriptive commit messages

Testing

# Run tests
npm test

# Run linting
npm run lint

Need Help?