Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.96 KB
Raw

Geist UI - React Contributing Guide

Ready to start

We welcome everyone to join in the construction of the project. As a pre requirement, you need to have a preliminary understanding of React, this is a good learning document for React. For basic operation of Git, you can refer to GitHub's help documentation.

  1. Fork this repository to your own account and then clone it.
  2. Create a new branch for your changes: git checkout -b {BRANCH_NAME}.
  3. Install Yarn and then update project dependenices: yarn.
  4. Run yarn dev and view your changes on your local document site. (If you add a new document page, you need to run yarn dev again)

At any time, you think it's ok, you can start the following steps to submit your amazing works:

  1. Run yarn lint check the code style.
  2. Run yarn test:update to update & run your testcase.
  3. Run git commit -ma '{YOUR_MESSAGE}' to commit changes. Commit info should be formatted by the rules.
  4. Push code to your own repo and create PullRequest at GitHub.

Common steps

Create component

  1. Create a folder in components, and add import to components/index.ts.
  2. Create a document file in pages/en-us/components/.
  3. Restart local server view changes: yarn dev.

About document page

  1. Document page must have meta field. refer to here.
  2. If you are creating a new component, please provide at least one document.
  3. Do Document using mdx-js, here is vs-code plug-in.

Create testcase

  1. If you are creating a new component, the testcase is required.
  2. If you only modify components, please note update test snapshot: yarn test-update.
  3. (Optional) Modifying testRegex in .jest.config.js allows you to test only a single component.
  4. Please check coverage locally before submit.

Q & A

How to choose the target branch of PR ?

  • If this is a feature, set to rc branch. All the others are set to master branch.

How to check my code style?

  • Run yarn prettier

I added a new document page, but it was not displayed locally ?

  • Run yarn dev again.

How can I update remote origin ?

Get stuck