Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.1 KB

Contributing to Chess Mazes

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on either one of Chess Mazes deployment sites, as per your PR.

Live Deployments:

Contributing

Prerequisites

Installation

  1. Fork the repo

  2. Clone the repo and checkout the main branch (replace <your-username> with your GitHub username):

    git clone https://github.com/<your-username>/chess-mazes.git
    cd chess-mazes
    git checkout main
  3. Install NPM packages

    npm install
  4. Run the development server

    npm run dev
  5. Open localhost:5173 with your browser to see the result.

  6. Before committing your changes, run the tests to make sure everything is working as expected, and lint the code to make sure it follows the project's style guidelines:

    npm run test
    npm run lint