From 3bb5f8c9e0854d3a7151aa6a87910c7d17c07616 Mon Sep 17 00:00:00 2001 From: jannyHou Date: Fri, 16 Feb 2018 12:43:29 -0500 Subject: [PATCH] doc: add new package --- MONOREPO.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/MONOREPO.md b/MONOREPO.md index ec677909de69..7dabb801d331 100644 --- a/MONOREPO.md +++ b/MONOREPO.md @@ -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).