Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 1.75 KB

Contributing Guide

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

Ready to start

We welcome everyone to join the construction of the project. As a pre requirement, you need have a preliminary understanding of NodeJS, if you don't know NodeJS this is a good learn document for NodeJS. And you can refer to GitHub's help documentation if you don't know the basic operation of Git

This project maintains monorepo by npm v8 workspace

To develop and test the core packages:

  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. Run npm i -ws in the root folder to install all dependencies.
  4. cd @summer-js/summer-test/ and run npm run serve to start

Create Feature

  1. Get into @summer-js/summer.
  2. Coding...
  3. Running npm run build.
  4. Get into @summer-js/summer-test/.
  5. Coding...
  6. Running npm run serve.

Create testcase

  1. If you are creating a new Characteristics, the testcase is required.
  2. If you only fix some bug, please note update test case.
  3. Please into @summer-js/summer-test/ & Running npm run test before submit.

Q & A

How can I update remote origin ?

How to choose the target branch of PR ?

  • Make sure PRs are make sure to dev branch.

Get stuck