CONTRIBUTION.md

CONTRIBUTION

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project. Pull Request Process

1. Find yourself an issue you want to work on, see if anybody is working on it, if not, then assign it to yourself
2. Fork the repo, create a branch for your issue
3. Make changes, commit and open a pull request into the master branch
4. Follow Conventional Commits while creating new commit
5. Request review from a contributor
6. If your pr was approved, rebase and squash your commits, then merge it.
7. Good job, you've just contributed!

You may merge your pull request after receiving an approval from Sean, or any other core contributor.

Development

This project uses the Vercel-CLI to run the application locally. You can install it by running npm i -g vercel.

After installation, use the vercel dev option to run the application alongside the necessary development serverless endpoints.

Documentation

Update the DOCUMENTATION if your contribution involves adding or changing configuration values.

If the environment variables being used are changed or added onto, then please update the .env.example file with the required keys.

This will help new contributors to understand how to both set up and use the application.

Localization

If your change involves making changes to the existing verbiage or adding new keys, then please ensure you add them to the relevant localization files. You can find the localization files in the /public/locales directory.

If you have added any new keys, you may run npm run sync-i18n to find the other core localization files that need to be update.

Code-style

Please set up your code style with prettier. This project has a .prettierrc.cjs file that can be used for code style.