Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (39 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

70 lines (39 loc) · 3.27 KB

Contributing Guide

Hi! We are really excited that you are interested in contributing to UnoCSS. Before submitting your contribution, please make sure to take a moment and read through the following guide.

Refer also to https://github.com/antfu/contribute.

Set up your local development environment

The UnoCSS repository is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be pnpm.

To develop and test UnoCSS, follow these steps:

  1. Fork the UnoCSS repository to your own GitHub account and then clone it to your local environment.

  2. Ensure you are using the latest Node.js LTS (>= 18.x).

  3. UnoCSS uses pnpm v9, if you are working on multiple projects with different versions of pnpm, it's recommended to enable Corepack by running corepack enable.

  4. Install dependencies: run pnpm install --frozen-lockfile from UnoCSS's root folder.

Development Workflow

If you are working on a new feature or bug, follow these steps:

  1. Check out a branch where you can work and commit your changes:
git checkout -b my-new-branch-or-feature

  1. Add the changes to the codebase.

  2. Add new tests when adding new features or fixing bugs (not always necessary, but it's a good practice): you can reuse existing tests or create new ones in the test folder. UnoCSS uses Vitest as the test runner.

  3. Test locally your changes by running the playground in your local environment

  4. Run pnpm stub or pnpm build to stub/build the packages: the playground will use the built packages

  5. run pnpm play and check your changes in the browser

  6. Run the tests: pnpm test and pnpm typecheck.

  7. Commit and push your changes to your fork using conventional commits. Then, create a pull request to the main branch of the UnoCSS repository:

git add .
git commit -m "feat: my new feature"
git push origin my-new-branch-or-feature

Documentation

UnoCSS documentation is built using VitePress,you can find the documentation in the docs folder: the documentation is written in Markdown and Vue components.

If you're working on fixing or enhancing the documentation, follow previous 1, 2 and 5 steps and then run pnpm docs to start the VitePress dev server.

UnoCSS also have a package for the interactive documentation, can be found in the interactive folder. If you're working on fixing or enhancing the interactive documentation, follow previous 1, 2 and 5 steps and then run pnpm interactive to start the dev server.

Finally, commit your changes and create a pull request to the main branch of the UnoCSS repository (check the previous step 8).

CI errors

Sometimes when you push your changes to create a new pull request (PR), the CI can fail, but we cannot check the logs to see what went wrong.

If you are getting Semantic Pull Request error, please check the Semantic Pull Request documentation.

You can run the following commands in your local environment to fix CI errors:

  • pnpm test to run unit tests, maybe you also need to update snapshots: in that case you can run pnpm test:update script
  • pnpm typecheck to run TypeScript checks run on CI