# Development Workflow

> We use [corepack with pnpm](https://pnpm.io/installation#using-corepack) for development.
> Please make sure you have node.js, npm installed and corepack enabled.

After cloning Milkdown, run `pnpm install` to install dependencies.

1. Run `pnpm build`.
2. Run `pnpm start` in one terminal to see storybook.

# Commands

You can run several commands:

- `pnpm clear` remove all build dist.
- `pnpm test:unit` runs unit test.
- `pnpm test:e2e` runs e2e test.
- `pnpm test:e2e:debug` runs e2e test with UI.
- `pnpm test:lint` checks the code style.
- `pnpm test:tsc` runs typescript type checks.
- `pnpm build` runs build for all packages.
- `pnpm commit` runs commit with git hooks.

# Pre Check

Before you create a pull request, please check the following todo:

- Pre commit hooks passed, please don't ignore it.
- `pnpm test` passed.

# License

By contributing to Milkdown, you agree that your contributions will be licensed under its MIT license.