Skip to content

Contributing

Contributions are very welcome. Thanks for your interest!

Setup the project

sh
git clone https://github.com/qwerty084/vue3-chessboard.git
sh
git clone git@github.com:qwerty084/vue3-chessboard.git
sh
gh repo clone qwerty084/vue3-chessboard

Install the required dependencies:

sh
npm install

Start the dev server:

sh
npm run dev

Now you can start developing 🚀

Creating a Pull Request

After adding your feature/bugfix please run the following scripts.

Format your changes

sh
npm run format

Type check your chages

sh
npm run type-check

Lint your changes

sh
npm run lint

Test your changes

sh
npm run test

Then create a branch with a fitting name, commit and push your changes.