From 462d5c3477ba7fa12ca2d6ca409ee2e2f1199097 Mon Sep 17 00:00:00 2001 From: Evan You Date: Thu, 10 Oct 2019 22:11:44 -0400 Subject: [PATCH] chore: mention coverage and template-explorer in contribution guide --- .github/contributing.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/contributing.md b/.github/contributing.md index 8f1eb4d5..84c34cb5 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -25,7 +25,7 @@ Hi! I'm really excited that you are interested in contributing to Vue.js. Before - If fixing bug: - If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`. - Provide a detailed description of the bug in the PR. Live demo preferred. - - Add appropriate test coverage if applicable. + - Add appropriate test coverage if applicable. You can check the coverage of your code addition by running `yarn test --coverage`. - It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging. @@ -150,6 +150,10 @@ This project uses a [monorepo](https://github.com/lerna/lerna#about) structure a - `compiler-dom`: Compiler with additional plugins specifically targeting the browser. +- `template-explorer`: A development tool for debugging compiler output. You can run `yarn dev template-explorer` ad open its `index.html` to get a repl of template compilation based on current source code. + + A [live version](https://vue-next-template-explorer.netlify.com) of the template explorer is also available, which can be used for providing reproductions for compiler bugs. You can also pick the deployment for a specific commit from the [deploy logs](https://app.netlify.com/sites/vue-next-template-explorer/deploys). + - `shared`: **Private.** Platform-agnostic internal utilities shared across multiple packages. This package is private and not published. - `vue`: The public facing "full build" which includes both the runtime AND the compiler.