Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 917 Bytes

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 917 Bytes

Contributing to Hypersonic

We love your input! We want to make contributing to Hypersonic as easy and transparent as possible.

Getting Started

  1. Fork the repo
  2. Clone your fork
  3. Create a branch:
    git checkout -b my-feature
  4. Make your changes
  5. Run tests:
    npm test
  6. Push to your fork
  7. Submit a Pull Request

Development Setup

# Install dependencies
npm install

# Run tests
npm test

# Build
npm run build

# Format code
npm run format

Pull Request Process

  1. Update documentation if needed
  2. Update tests if needed
  3. Follow our coding style (prettier + eslint)
  4. Make sure all tests pass
  5. Make sure the build succeeds

Coding Style

  • We use Prettier for formatting
  • We use ESLint for linting
  • TypeScript strict mode is enabled

License

By contributing, you agree that your contributions will be licensed under the MIT License.