CONTRIBUTING.md

Contribution Guidelines

Table of Contents

• Development workflow
  • Install dependencies
• How to contribute

Development workflow

We use pnpm as our package manager.

Install dependencies

git clone [email protected]:pedakihq/pedaki.git
cd pedaki
pnpm install

How to contribute

Recommended workflow

Open two terminals:

1. In the first one, run pnpm dev to start the development server.
2. On the second one, run pnpm build to rebuild the project when you make changes.
   1. To sync your changes I recommend to use yalc to publish your local changes to your local npm registry. (yalk push in the packages you want to sync, yalk add <package-name> in the project you want to use the local version of the package)

Useful commands

Command	Description
pnpm build	Build the project
pnpm build:watch	Build the project
pnpm dev	Start the development server
pnpm mail:dev	Start the mail preview server, alias for pnpm dev --filter mailer
pnpm test	Run the tests
pnpm test:watch	Run the tests
pnpm test:coverage	Run the tests
pnpm lint	Run the linter
pnpm check	Run the tests and the linter
pnpm changeset	Create a changeset

Prerequisites

Before you submit your pull request, start by opening an issue describing the problem you want to solve.
This will allow us to discuss this change and make sure it's not already being worked on.

When you are done

Check that your code passes the tests and linting:

pnpm check

If your change should appear in the changelog:

pnpm changeset

and follow the instructions. Then, commit the changeset:

git add .changeset/*.md && git commit -m "chore: add changeset"

Finally, push your changes and open a pull request.