diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09ce1ce..0a5ec59 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,8 +14,9 @@ pnpm install ## Pull Request -- Checkout a topic branch from a base branch, e.g. master, and merge back against that branch. +- Checkout a topic branch from a base branch, e.g. fix-bug, and merge back against that branch. - It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging. - To check that your contributions match the project coding style make sure `pnpm lint` && `pnpm typecheck` passes. To build project run: `pnpm build`. - Commit messages must follow the [commit message convention](./.github/commit-convention.md). Commit messages are automatically validated before commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks)). +- Commit messages preferably in English. - No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks)).