Contributing

Thank you for your interest in contributing to HyperFrontend! This guide will help you get started.

Getting Started

  1. 1
    Fork the repository

    Create your own fork of hyperfrontend on GitHub.

  2. 2
    Clone and install
    git clone https://github.com/YOUR_USERNAME/hyperfrontend.git cd hyperfrontend npm install
  3. 3
    Create a branch
    git checkout -b feat/your-feature-name
  4. 4
    Make your changes

    Write your code, add tests, and ensure all checks pass.

  5. 5
    Submit a pull request

    Open a PR against the main branch with a clear description of your changes.

Development Commands

Run tests

npx nx run-many -t test

Run linting

npx nx run-many -t lint

Build all packages

npx nx run-many -t build

Run a specific demo

npx nx serve chess

Code Style

  • Follow existing code conventions and patterns
  • Use Conventional Commits for commit messages
  • Add tests for new functionality
  • Update documentation as needed

Contributor License Agreement

By contributing to HyperFrontend, you agree to our Contributor License Agreement. This ensures we can continue to distribute the project under its license.

Questions?

If you have questions or need help, feel free to start a discussion on GitHub.