Skip to content

Latest commit

 

History

History
131 lines (97 loc) · 3.83 KB

CONTRIBUTING.md

File metadata and controls

131 lines (97 loc) · 3.83 KB
Raw

Contributing

Thanks for showing interest in contributing to ILLA, we think you are the best one!

Here's the table of contents:

  • Setup the Project
    • Commands
  • Create a New Component
    • Directory Structure
  • Make a Pull Request
    • Commit Convention
    • Steps to PR
    • Some Rules

Setup the Project

  1. Fork the repo (click the Fork button at the top right of this page
  2. Clone your fork locally
  3. Setup all the dependencies and packages by running pnpm install.

If you have some problems, you can take an issue or talk with others on Discord

Commands:

# start the storybook to preview the components
$ pnpm storybook

# lint all code
$ pnpm lint

# build all components
$ pnpm build-all-components

# run jest & cypress to test all components
$ pnpm test

# open cypress test UI on chrome
$ pnpm cypress run-ct -b chrome

# create a new component
$ pnpm plop

# pull & buld & start storybook
$ pnpm build-develop

# build storybook project for publish
$ pnpm build-storybook

# only run jest
$ pnpm unit-test

Create a New Component

You can run the plop script to create a new component.

$ pnpm plop

Then only add some props you can create a new component.

Know more about Plop

You can find it in "packages/{component name}"

Directory Structure

├── src
│   ├── index.ts                  # index file for this component.
│   ├── {name}.tsx                # main code file
│   ├── style.tsx                 # emotion css style
│   ├── interface.ts              # the component props
│   └── vite-env.d.ts             # vite flag
├── stories
│   └── {name}.stories.tsx        # the storybook file
├── tests
│   ├── __snapshots__             # jest snapshot directory
│   │   └── {name}.test.tsx.snap  # auto generate snapshot file
│   ├── {name}.e2e.tsx            # cypress test cases
│   └── {name}.test.tsx           # jest test cases
├── dist                          # build production
├── .gitignore                    # gitignore file
├── CHANGELOG.md                  # component changelog
├── tsconfig.json                 # typescript build config
├── vite.config.ts                # vite config
└── package.json                  # this component dependencies(monorepo)

Make a Pull Request

If you have some changes, you can make a pull request to let ILLA be better!

Commit Convention

This project uses the commitlint to lint commit.

Please follow the conventional to add the commit messages.

We use the husky to check the commit message before every commit action.

Steps to PR

  1. Fork of the repository and clone your fork
  2. Create a new branch out of the develop branch. We follow the convention [type/scope]. For example fix/accordion-hook or docs/menu-typo. type can be either docs, fix, feat, build, or any other conventional commit type. scope is just a short id that describes the scope of work.
  3. Make and commit your changes following the Commit Convention, As you develop, you can run pnpm lint and pnpm lint to make sure everything works as expected. Please note that you might have to run yarn first in order to install all dependencies.
  4. We have a pull request template, you only need to add some necessary info to let others know what this pr does.

Some Rules

  1. We need complete unit testing, so please check your test code before committing.
  2. Try not to reduce unit test coverage.