Hi! We are really excited that you are interested in contributing to Kai. Before submitting your contribution, please make sure to take a moment and read through the following guide:
The Kai repo is a monorepo using pnpm and rush.js. The package manager used to install and link dependencies must be pnpm.
To develop and test the core Kai package:
-
Run
rush updatein Kai's root folder -
Run
pnpm run buildin each Kai's sub app.
Kai uses pnpm v7. If you are working on multiple projects with different versions of pnpm, it's recommend to enable Corepack by running
corepack enable.
-
Checkout a topic branch from a base branch, e.g.
master, and merge back against that branch. -
If adding a new feature:
- Add accompanying test case.
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
-
If fixing bug:
- If you are resolving a special issue, add
(fix #xxxx[,#xxxx])(#xxxx is the issue id) in your PR title for a better release log, e.g.fix: update entities encoding/decoding (fix #3899). - Provide a detailed description of the bug in the PR. Live demo preferred.
- Add appropriate test coverage if applicable.
- If you are resolving a special issue, add
-
It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
-
Make sure tests pass!
-
Commit messages must follow the Angular Team's Commit Message Guidelines so that changelogs can be automatically generated. Commit messages are automatically validated before commit.
-
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.