Contributing

Jump in the pit and add something new!

Getting Started

Where username is your GitHub username and work-description is a short description of your contribution.

For example: mster/support-CMYK

Complete your contribution and commit your work to the branch you created.
When you're ready for review or to submit your contribution, double check a few things.

✓ First, make sure your fork is up to date. If your fork is out of date, you will need to rebase.
✓ Next, assure that your code pases all tests.
```
npm test
```
See Testing for more information.

If your contribution is more than a single commit, squash all commits into one. Provide a brief description of your work inside the commit message.
Open a pull request to main and request review from user @mster.
Make any changes suggested during review.
You will be added to the list of contributors and have your code merged.

Have an feature in mind? Go for it -- if we like it, we will add it. You can always open a "Work in Progress" pull request.

Follow the Getting Started guide if you're new to this.

Prismaek uses Prettier. To have your contributions accepted, they must also be in this style.

To test if your code passes, run the test command:

npm run lint

To auto-fix any linting issues, use the command:

npm run lint-fix

Prismaek uses Jest as our testing framework. To run these tests use the command:

npm run jest

We're happy to help out, no matter how small the issue.

Open an issue, ping the author (@mster), or join the Discord.