Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.14 KB

File metadata and controls

45 lines (30 loc) · 1.14 KB

Contributing to Retro Game Player

Thank you for your interest in contributing! We welcome bug reports, feature requests, and pull requests.

Development Setup

  1. Clone the repository:

    git clone https://github.com/beingmudit/retro-game-player.git
    cd retro-game-player
  2. Install dependencies:

    npm install
    # or
    pnpm install
  3. Start the development server:

    npm run dev

    This will start the example app where you can test your changes.

Project Structure

  • src/components: React components (UI, overlays, controls).
  • src/hooks: Custom hooks for logic (emulator, input, etc.).
  • src/lib: Utility functions and system configurations.
  • src/data: Static data (system definitions).

Guidelines

  • Code Style: We use ESLint and Prettier. Please ensure your code is linted before submitting.
  • Commits: Use descriptive commit messages.
  • Features: If adding a new feature, please open an issue first to discuss it.

License

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