Skip to main content

Contributing to Project Name

Thank you for your interest in contributing! This document provides guidelines for contributing to this project.

Getting Started​

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/repo.git
  3. Create a feature branch: git checkout -b feature-name
  4. Make your changes
  5. Test your changes: npm test
  6. Commit your changes: git commit -m "Description of changes"
  7. Push to your fork: git push origin feature-name
  8. Create a Pull Request

Development Setup​

npm install
npm run dev

Code Style​

  • Use TypeScript for new code
  • Follow existing code formatting
  • Run npm run lint before committing
  • Add tests for new features

Pull Request Guidelines​

  • Keep PRs focused and small
  • Include tests for new functionality
  • Update documentation as needed
  • Ensure CI passes
  • Link to relevant issues

Reporting Issues​

Use our issue templates when reporting bugs or requesting features.

Code of Conduct​

Please read and follow our Code of Conduct.