CONTRIBUTING.md

Contributing to Jaffle

Hi there! If you read this, you are considering to contribute to the Jaffle project, thank you! This can be done in several ways.

Contributing to Strudel and TidalCycles

Jaffle is based on Strudel and TidalCycles, so any contribution to those projects will benefit Jaffle.

• Strudel repository
• Tidal repository
• TidalCycles collective fund

Sending feedback

They are highly appreciated! You can either:

• create issues and suggestions on Github;
• say hello to @roipoussiere on the Strudel Discord;
• contact me on Mastodon: @roipoussiere@tetaneutral.net.

Contributing to code

Get the project

git clone https://github.com/roipoussiere/jaffle.git
cd jaffle

Install dependencies

npm install

Or use Yarn or Pnpm if you prefer.

Start the website

npm run dev

Run tests

npm test

If you use VSCode, you may want to install the Jest extension.

Run linter

npm run lint

If you use VSCode, you may want to install the ESlint extension.