chore: contribution guide
This commit is contained in:
Evan You
parent
a39aa842f3
commit
549e1e1514
91
.github/commit-convention.md
vendored
Normal file
91
.github/commit-convention.md
vendored
Normal file
@ -0,0 +1,91 @@
|
||||
## Git Commit Message Convention
|
||||
|
||||
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
|
||||
|
||||
#### TL;DR:
|
||||
|
||||
Messages must be matched by the following regex:
|
||||
|
||||
``` js
|
||||
/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/
|
||||
```
|
||||
|
||||
#### Examples
|
||||
|
||||
Appears under "Features" header, `compiler` subheader:
|
||||
|
||||
```
|
||||
feat(compiler): add 'comments' option
|
||||
```
|
||||
|
||||
Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue #28:
|
||||
|
||||
```
|
||||
fix(v-model): handle events on blur
|
||||
|
||||
close #28
|
||||
```
|
||||
|
||||
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
|
||||
|
||||
```
|
||||
perf(core): improve vdom diffing by removing 'foo' option
|
||||
|
||||
BREAKING CHANGE: The 'foo' option has been removed.
|
||||
```
|
||||
|
||||
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
|
||||
|
||||
```
|
||||
revert: feat(compiler): add 'comments' option
|
||||
|
||||
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
|
||||
```
|
||||
|
||||
### Full Message Format
|
||||
|
||||
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
|
||||
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
<BLANK LINE>
|
||||
<body>
|
||||
<BLANK LINE>
|
||||
<footer>
|
||||
```
|
||||
|
||||
The **header** is mandatory and the **scope** of the header is optional.
|
||||
|
||||
### Revert
|
||||
|
||||
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
|
||||
|
||||
### Type
|
||||
|
||||
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
|
||||
|
||||
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
|
||||
|
||||
### Scope
|
||||
|
||||
The scope could be anything specifying the place of the commit change. For example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...
|
||||
|
||||
### Subject
|
||||
|
||||
The subject contains a succinct description of the change:
|
||||
|
||||
* use the imperative, present tense: "change" not "changed" nor "changes"
|
||||
* don't capitalize the first letter
|
||||
* no dot (.) at the end
|
||||
|
||||
### Body
|
||||
|
||||
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
|
||||
The body should include the motivation for the change and contrast this with previous behavior.
|
||||
|
||||
### Footer
|
||||
|
||||
The footer should contain any information about **Breaking Changes** and is also the place to
|
||||
reference GitHub issues that this commit **Closes**.
|
||||
|
||||
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
||||
178
.github/contributing.md
vendored
Normal file
178
.github/contributing.md
vendored
Normal file
@ -0,0 +1,178 @@
|
||||
# Vue.js Contributing Guide
|
||||
|
||||
Hi! I'm really excited that you are interested in contributing to Vue.js. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
|
||||
|
||||
- [Code of Conduct](https://github.com/vuejs/vue/blob/dev/.github/CODE_OF_CONDUCT.md)
|
||||
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
|
||||
- [Pull Request Guidelines](#pull-request-guidelines)
|
||||
- [Development Setup](#development-setup)
|
||||
- [Project Structure](#project-structure)
|
||||
|
||||
## Issue Reporting Guidelines
|
||||
|
||||
- Always use [https://new-issue.vuejs.org/](https://new-issue.vuejs.org/) to create new issues.
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- 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.
|
||||
|
||||
- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
|
||||
|
||||
- Make sure tests pass!
|
||||
|
||||
- Commit messages must follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated. Commit messages are automatically validated before commit.
|
||||
|
||||
- No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit.
|
||||
|
||||
## Development Setup
|
||||
|
||||
You will need [Node.js](http://nodejs.org) **version 10+**, and [Yarn](https://yarnpkg.com/en/docs/install).
|
||||
|
||||
After cloning the repo, run:
|
||||
|
||||
``` bash
|
||||
$ yarn # install the dependencies of the project
|
||||
```
|
||||
|
||||
A high level overview of tools used:
|
||||
|
||||
- [TypeScript](https://www.typescriptlang.org/) as the development language
|
||||
- [Rollup](https://rollupjs.org) for bundling
|
||||
- [Jest](https://jestjs.io/) for unit testing
|
||||
- [Prettier](https://prettier.io/) for code formatting
|
||||
- [Lerna](https://github.com/lerna/lerna) for monorepo management
|
||||
|
||||
## Scripts
|
||||
|
||||
### `yarn build`
|
||||
|
||||
The `build` script builds all public packages (packages without `private: true` in their `package.json`).
|
||||
|
||||
Packages to build can be specified with fuzzy matching:
|
||||
|
||||
``` bash
|
||||
# build runtime-core only
|
||||
yarn build runtime-core
|
||||
|
||||
# build all packages matching "runtime"
|
||||
yarn build runtime
|
||||
```
|
||||
|
||||
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 `<script>` in the browser. The global variable exposed is specified via the `buildOptions.name` field in a package's `package.json`.
|
||||
- **`esm`**: for use with bundlers.
|
||||
- **`esm-browser`**: for in-browser usage via native ES modules import (`<script type="module">`)
|
||||
- **`cjs`**: for use in Node.js via `require()`.
|
||||
|
||||
For example, to build `runtime-core` with the global build only:
|
||||
|
||||
``` bash
|
||||
yarn build runtime-core -f global
|
||||
```
|
||||
|
||||
Multiple formats can be specified as a comma-separated list:
|
||||
|
||||
``` bash
|
||||
yarn build runtime-core -f esm,cjs
|
||||
```
|
||||
|
||||
### `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:
|
||||
|
||||
``` bash
|
||||
$ yarn dev
|
||||
|
||||
> rollup v1.19.4
|
||||
> bundles packages/vue/src/index.ts → packages/vue/dist/vue.global.js...
|
||||
```
|
||||
|
||||
- The `dev` script also supports fuzzy match for the target package, but will only match the first package matched.
|
||||
|
||||
- The `dev` script supports specifying build format via the `-f` flag just like the `build` script.
|
||||
|
||||
### `yarn test`
|
||||
|
||||
The `yarn test` script simply calls the `jest` binary, so all [Jest CLI Options](https://jestjs.io/docs/en/cli) can be used. Some examples:
|
||||
|
||||
``` bash
|
||||
# run all tests
|
||||
$ yarn test
|
||||
|
||||
# run tests in watch mode
|
||||
$ yarn test --watch
|
||||
|
||||
# run all tests under the runtime-core package
|
||||
$ yarn test runtime-core
|
||||
|
||||
# run tests in a specific file
|
||||
$ yarn test fileName
|
||||
|
||||
# run a specific test in a specific file
|
||||
$ yarn test fileName -t 'test name'
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
This project uses a [monorepo](https://github.com/lerna/lerna#about) structure and contains the following packages:
|
||||
|
||||
- `reactivity`: The reactivity system. It can be used standalone as a framework-agnostic package.
|
||||
|
||||
- `runtime-core`: The platform-agnostic runtime core. Includes code for the virtual dom renderer, component implementation and JavaScript APIs. Higher-order runtimes (i.e. custom renderers) targeting specific platforms can be created using this package.
|
||||
|
||||
- `runtime-dom`: The runtime targeting the browser. Includes handling of native DOM API, attributes, properties, event handlers etc.
|
||||
|
||||
- `runtime-test`: The lightweight runtime for testing. Can be used in any JavaScript environment since it "renders" a tree of plain JavaScript objects. The tree can be used to assert correct render output. Also provides utilities for serializing the tree, triggering events, and recording actual node operations performed during an update.
|
||||
|
||||
- `server-renderer`: Package for server-side rendering.
|
||||
|
||||
- `compiler-core`: The platform-agnostic compiler core. Includes the extensible base of the compiler and all platform-agnostic plugins.
|
||||
|
||||
- `compiler-dom`: Compiler with additional plugins specifically targeting the browser.
|
||||
|
||||
- `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.
|
||||
|
||||
Note that when importing these packages, the `@vue/` prefix is needed:
|
||||
|
||||
``` js
|
||||
import { h } from '@vue/runtime-core'
|
||||
```
|
||||
|
||||
## Contributing Tests
|
||||
|
||||
Unit tests are collocated with the code being tested in each package, inside directories named `__tests__`. Consult the [Jest docs](https://jestjs.io/docs/en/using-matchers) and existing test cases for how to write new test specs. Here are some additional guidelines:
|
||||
|
||||
- Use the minimal API needed for a test case. For example, if a test can be written without involving the reactivity system or a component, it should be written so. This limits the test's exposure to changes in unrelated parts and makes it more stable.
|
||||
|
||||
- If testing platform agnostic behavior or asserting low-level virtual DOM operations, use `@vue/runtime-test`.
|
||||
|
||||
- Only use platform-specific runtimes if the test is asserting platform-specific behavior.
|
||||
|
||||
## Financial Contribution
|
||||
|
||||
As a pure community-driven project without major corporate backing, we also welcome financial contributions via Patreon and OpenCollective.
|
||||
|
||||
- [Become a backer or sponsor on Patreon](https://www.patreon.com/evanyou)
|
||||
- [Become a backer or sponsor on OpenCollective](https://opencollective.com/vuejs)
|
||||
|
||||
### What's the difference between Patreon and OpenCollective funding?
|
||||
|
||||
Funds donated via Patreon go directly to support Evan You's full-time work on Vue.js. Funds donated via OpenCollective are managed with transparent expenses and will be used for compensating work and expenses for core team members or sponsoring community events. Your name/logo will receive proper recognition and exposure by donating on either platform.
|
||||
|
||||
## Credits
|
||||
|
||||
Thank you to all the people who have already contributed to Vue.js!
|
||||
|
||||
<a href="https://github.com/vuejs/vue/graphs/contributors"><img src="https://opencollective.com/vuejs/contributors.svg?width=890" /></a>
|
||||
Loading…
Reference in New Issue
Block a user