diff --git a/.github/contributing.md b/.github/contributing.md index 7d95346ed2f..122cf0e0c52 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -19,10 +19,12 @@ Hi! I'm really excited that you are interested in contributing to Vue.js. Before - Checkout a topic branch from a base branch, e.g. `master`, and merge back against that branch. - If adding a new feature: + - Add accompanying test case. - Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it. - 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. You can check the coverage of your code addition by running `yarn test --coverage`. @@ -41,7 +43,7 @@ You will need [Node.js](http://nodejs.org) **version 10+**, and [Yarn](https://y After cloning the repo, run: -``` bash +```bash $ yarn # install the dependencies of the project ``` @@ -60,7 +62,7 @@ The `build` script builds all public packages (packages without `private: true` Packages to build can be specified with fuzzy matching: -``` bash +```bash # build runtime-core only yarn build runtime-core @@ -73,10 +75,12 @@ yarn build runtime --all By default, each package will be built in multiple distribution formats as specified in the `buildOptions.formats` field in its `package.json`. These can be overwritten via the `-f` flag. The following formats are supported: - **`global`**: + - For direct use via `