Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 1015 Bytes

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 1015 Bytes

Contribute

Notice: y is the alias for yarn, n is the alias for npm.

Set up

Install dev deps after git clone the repo.

$ y

Bootstrap every package with yarn. (Need to execute when new package is included)

$ y bootstrap

Link father globally.

$ cd packages/father
$ y link

Common Tasks

Monitor file changes and transform with babel.

$ y build --watch

Run test.

# Including e2e test
$ y test

# Unit test only
$ y debug .test.(t|j)s

# Test specified file and watch
$ y debug father-build/src/build.test.ts -w

Publish

Add tag for PRs, changelog is generated based on these tags.

  • pr(bug)
  • pr(enhancement)
  • pr(chore)
  • pr(dependency)

Generate changelog.

$ y changelog

Publish to npm.

# Can't use yarn for this command.
$ n run publish

Debug doc in local.

$ y doc:dev

Paste the previously generated changelog at umijs/father#release.