Hi! I'm really excited that you are interested in contributing to LEOSTAR-UI. Before submitting your contribution, please make sure to take a moment and read through the following guidelines
You will need Node.js version 16+, and PNPM version 8+.
After cloning the repo, run:
$ pnpm i # install the dependencies of the projectA high level overview of tools used:
- @antfu/ni as pagkage manager
- TypeScript as the development language
- Vite and ESBuild for development bundling
- Vitest for unit testing
- Tsx for run TypeScript
- React for frontend framework
- Unocss for frontend styling
- Prettier for code formatting
- ESLint for static error prevention (outside of types)
We recommend using VSCode with the following extensions:
- editorconfig.editorconfig for editorconfig
- dbaeumer.vscode-eslint for eslint
- esbenp.prettier-vscode for prettier
- lokalise.i18n-ally for i18n preview in vscode
- antfu.unocss for unocss preview in vscode
The project uses husky to enforce the following on each commit:
- Check unit tests before push
- Automatically format changed files using Prettier & Eslint
- Verify commit message format (conventional commit)
The build script builds all packages in the repository. It is equivalent to running pnpm build in each package directory.
We use [commitlint] (https://commitlint.js.org/) to check the submitted information. It will check that the submitted message conforms to the format we have defined. If the submission message does not conform to the format, it will return an error that is used, usage nr commit=git add . && cz-git。