Skip to content

CONTRIBUTING.en-US.md

Latest commit

 

History

History
64 lines (41 loc) · 3.43 KB

CONTRIBUTING.en-US.md

File metadata and controls

64 lines (41 loc) · 3.43 KB

简体中文 ｜ English

Any kind of contribution is welcome

"My code level is not good ." "Will it be despised?" "Will it be bad?" Don't worry. Feel free to contribute.

We welcome any contribution, whether it's a typo correction or a friendly suggestion, whether it's submitted by Issue, a cool pull request, or a DingTalk group discussion, participate in discussions, look forward to seeing your profile picture in Contributor List.

Branch Management

Currently, we are developing based on the master branch. Please check out a branch based on master, and Pull Request if you have any modifications. We will review your PR for the first time and give you feedback.

Report bugs

We are sorry to push bugs. And we would appreciate that if you could report them to us. To save time on the communication, please give details about the bug as much as possible.

Bad case

preview

Good case

  1. First select [Bug report]

    preview

  2. Fill in the relevant information according to the Issue template.

    We are sorry that these steps are a bit redundant. Since every user uses S2 in different situations, system environment, software version, specific steps to reproduce the bug could help us solve the issue in time.

    preview

Pull Request

  1. Fork the project and clone it (or use GitHub's Codespace function, which is very convenient).
  2. Installation dependency: yarn bootstrap or yarn.
  3. Commit your changes, and please follow [AngularJS Git Commit Message Conventions] (https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w).
  4. If your change is a bug fix, you can add close #issue number after the submission information so that after the pr merge, the related issue could be closed automatically. eg: fix: render bug close #123.
  5. Make sure to add the related unit test.
  6. After all Lint and Test checks are passed, and the review is passed, we will merge your pr.

preview

Development Process

We use yarn@v1 as package management.

npm i -g yarn
  1. yarn bootstrap: Installation dependency.
  2. yarn site:bootstrap: Install site related dependencies.
  3. yarn site:start: Starts the local S2 website.
  4. yarn core:start: Debug and test local @antv/s2（Based on jest-electron）.
  5. yarn react:start Debug and test local @antv/s2-react (Based on jest-electron).
  6. yarn vue:start Debug and test local @antv/s2-vue (Based on jest-electron).
  7. yarn react:playground Starts the local @antv/s2-react playground (Based on vite).
  8. yarn vue:playground Starts the local @antv/s2-vue playground (Based on vite).
  9. yarn build: Builds @antv/s2 and @antv/s2-react and @antv/s2-vue , outputs are umd, esm and lib directories.
  10. yarn test: Run unit tests.