Contributing Guidelines

Thanks for contributing! Any contributions you make are greatly appreciated (and rewarded with pizza).

Getting Started

Fork the repository to your own GitHub account.
Clone the forked repository to your local machine.
Create a new branch for your feature or bug fix. Use a descriptive name, such as feature/feature-name.
Using Prettier and ESLint is necessary. Make sure that your code is properly formatted and follows our coding style guidelines. You can format your code by running npm run format and lint your code by running npm run lint.
Write tests to cover your changes and ensure they pass by running npm run test.
Commit your changes with a clear and concise commit message. Follow good Git commit message practices, such as using prefixes like fix, feat, chore, test, etc.

Push your branch to your forked repository.
Go to the original repository and create a new pull request.
Provide a descriptive title and detailed description of your changes in the pull request.
Wait for the pull request to be reviewed by the project maintainers.
Address any feedback or comments given during the review process.
Ensure that all automatic CI checks pass. These checks include formatting with Prettier, linting with ESLint, building the project, and running tests.
Once your pull request is approved, it will be merged into the main branch.

Our project is hosted on Cloudflare pages. Once your changes are merged, they will be deployed to our production environment.

Thank you for your contributions!