From: Evan You <yyx990803@gmail.com>
Date: Tue, 3 Sep 2019 16:22:56 +0000 (-0400)
Subject: chore: document build --types
X-Git-Tag: v3.0.0-alpha.0~846
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1b6f0992d954c546a539259ed846f68d431c46b6;p=thirdparty%2Fvuejs%2Fcore.git

chore: document build --types
---

diff --git a/.github/contributing.md b/.github/contributing.md
index 0a610a88d3..92b4c0795a 100644
--- a/.github/contributing.md
+++ b/.github/contributing.md
@@ -88,6 +88,14 @@ Multiple formats can be specified as a comma-separated list:
 yarn build runtime-core -f esm,cjs
 ```
 
+#### Build with Type Declarations
+
+The `--types` flag will generate type declarations during the build and in addition:
+
+- Roll the declarations into a single `.dts` file for each package;
+- Generate an API report in `<projectRoot>/temp/<packageName>.api.md`. This report contains potential warnings emitted by [api-extractor](https://api-extractor.com/).
+- Generate an API model json in `<projectRoot>/temp/<packageName>.api.md`. This file can be used to generate a Markdown version of the exported APIs.
+
 ### `yarn dev`
 
 The `dev` script bundles a target package (default: `vue`) in a specified format (default: `global`) in dev mode and watches for changes. This is useful when you want to load up a build in an HTML page for quick debugging: