Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

111 lines (72 loc) · 1.73 KB

Reduck Contributing Guide

Thanks for that you are interested in contributing to Reduck.

Developing

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local.

  2. Create a new branch:

    git checkout -b MY_BRANCH_NAME
  3. Install pnpm:

    npm install -g pnpm
  4. Install the dependencies with:

    pnpm run setup
  5. Go into package which you want to contribute.

    cd ./packages/
  6. Start developing.

Building

You can build single package, with:

cd ./packages/*
pnpm build

build all packages, with:

pnpm -r prepare

If you need to clean all node_modules/* the project for any reason, with

pnpm reset

Testing

You need write new test cases for new feature or modify existing test cases for changes.

We wish you write unit tests at PACKAGE_DIR/__test__. Test syntax is based on jest.

Run Testing

pnpm -r test

Linting

To check the formatting of your code:

pnpm lint

Publishing

We use Modern.js Monorepo Solution to manage version and changelog.

Repository maintainers can publish a new version of all packages to npm.

  1. Fetch newest code at branch main.

  2. Install

    pnpm run setup
  3. Add changeset

    pnpm change
  4. Bump version

    pnpm bump
  5. Commit version change. The format of commit message should be chore: va.b.c which is the main version of current release.

    git add .
    git commit -m "chore: va.b.c"