CONTRIBUTING.md

Contributions

🔮 Thanks for considering contributing to this project! 🔮

These guidelines will help you send a pull request.

If you're submitting an issue instead, please skip this document.

If your pull request is related to a typo or the documentation being unclear, please click on the relevant page's Edit button (pencil icon) and directly suggest a correction instead.

This project was made with your goodwill. The simplest way to give back is by starring and sharing it online.

Everyone is welcome regardless of personal background.

Development process

First fork and clone the repository.

Run:

yarn

Make sure everything is correctly setup with:

yarn test

Create a new translation file

When creating a new translation file, copy packages/core/src/locales/en/zod.json and name the file with the locale code.

After creation and customization is complete, copy packages/core/tests/integrations/en.test.ts and create a new test file.

How to write commit messages

We use Conventional Commit messages to automate version management.

Most common commit message prefixes are:

• fix: which represents bug fixes, and generate a patch release.
• feat: which represents a new feature, and generate a minor release.