Skip to content

Commit

Permalink
doc: add new package
Browse files Browse the repository at this point in the history
  • Loading branch information
jannyHou committed Feb 16, 2018
1 parent 7a4545e commit 3bb5f8c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions MONOREPO.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,19 @@ The `release` script will automatically perform the tasks for all packages:
- Check lint (tslint and prettier) issues

If all steps are successful, it prompts you to publish packages into npm repository.

### Add a package

To add a new package, create a folder in [`packages`](packages) as the module folder, it is
like a common npm module with configuration files and your source code.

We have some configuration files at the top level:

- `.gitignore`
- `.prettierignore`
- `.nycrc.yml`

For the consistency among all packages, no need to add them at package level unless there is a difference.

Also add the new package and your name as its owner in [CODEOWNERS](CODEOWNERS).
And add the new module in the 'packages' list in [MONOREPO#packages](MONOREPO#packages).

0 comments on commit 3bb5f8c

Please sign in to comment.