Contributing 🤩

Kia ora! Would you like to contribute? That's awesome, thank you so much for your interest in this project!

Before you go committing your amazing contribution please read the following guidelines.

Getting started 🐤

Here are some things to know before you start coding.

We use the following dependencies for development:

We use a number of quality of life tools to streamline development, install them via the command line.

composer install
yarn install

To keep the codebase tidy, use the following script to clean each commit.

composer lint

Each commit should adhere to the following structure.

:gitmoji: type(scope?): subject
body?
footer?

Be sure to run the test suite regularly. New tests should be added for new features.

vendor/bin/phpunit

This project uses changesets. This tool helps us to streamline our changelog.

When making a pull request, be sure to add a changeset if there has been a change to the project.

npx changeset