Skip to content

Commit 4015deb

Browse files
JakeConnors376Wyyx990803
authored andcommitted
chore: make documentation clearer (vuejs#9450)
1 parent f9c8308 commit 4015deb

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

.github/CONTRIBUTING.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Vue.js Contributing Guide
22

3-
Hi! Im really excited that you are interested in contributing to Vue.js. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
3+
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:
44

55
- [Code of Conduct](https://github.com/vuejs/vue/blob/dev/.github/CODE_OF_CONDUCT.md)
66
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
@@ -14,28 +14,28 @@ Hi! I’m really excited that you are interested in contributing to Vue.js. Befo
1414

1515
## Pull Request Guidelines
1616

17-
- The `master` branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**
17+
- The `master` branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**
1818

1919
- Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch.
2020

2121
- Work in the `src` folder and **DO NOT** checkin `dist` in the commits.
2222

23-
- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.
23+
- It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.
2424

2525
- Make sure `npm test` passes. (see [development setup](#development-setup))
2626

2727
- If adding new feature:
2828
- Add accompanying test case.
29-
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
29+
- Provide convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
3030

31-
- If fixing a bug:
32-
- If you are resolving a special issue, add `(fix #xxxx[,#xxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`.
31+
- If fixing bug:
32+
- 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)`.
3333
- Provide detailed description of the bug in the PR. Live demo preferred.
3434
- Add appropriate test coverage if applicable.
3535

3636
## Development Setup
3737

38-
You will need [Node.js](http://nodejs.org) **version 6+** and [Java Runtime Environment](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (needed for running Selenium server during e2e tests).
38+
You will need [Node.js](http://nodejs.org) **version 6+** and [Java Runtime Environment](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (for running Selenium server during e2e tests).
3939

4040
After cloning the repo, run:
4141

@@ -65,11 +65,11 @@ $ npm test
6565

6666
There are some other scripts available in the `scripts` section of the `package.json` file.
6767

68-
The default test script will do the following: lint with ESLint -> type check with Flow -> unit tests with coverage -> e2e tests. **Please make sure to have this pass successfully before submitting a PR.** Although the same tests will be run against your PR on the CI server, it is better to have it working locally beforehand.
68+
The default test script will do the following: lint with ESLint -> type check with Flow -> unit tests with coverage -> e2e tests. **Please make sure to have this pass successfully before submitting a PR.** Although the same tests will be run against your PR on the CI server, it is better to have it working locally.
6969

7070
## Project Structure
7171

72-
- **`scripts`**: contains build-related scripts and configuration files. In most cases you don't need to touch them. However, it would be helpful to familiarize yourself with the following files:
72+
- **`scripts`**: contains build-related scripts and configuration files. Usually, you don't need to touch them. However, it would be helpful to familiarize yourself with the following files:
7373

7474
- `scripts/alias.js`: module import aliases used across all source code and tests.
7575

@@ -85,51 +85,51 @@ The default test script will do the following: lint with ESLint -> type check wi
8585

8686
- **`test`**: contains all tests. The unit tests are written with [Jasmine](http://jasmine.github.io/2.3/introduction.html) and run with [Karma](http://karma-runner.github.io/0.13/index.html). The e2e tests are written for and run with [Nightwatch.js](http://nightwatchjs.org/).
8787

88-
- **`src`**: contains the source code, obviously. The codebase is written in ES2015 with [Flow](https://flowtype.org/) type annotations.
88+
- **`src`**: contains the source code. The codebase is written in ES2015 with [Flow](https://flowtype.org/) type annotations.
8989

9090
- **`compiler`**: contains code for the template-to-render-function compiler.
9191

92-
The compiler consists of a parser (converts template strings to element ASTs), an optimizer (detects static trees for vdom render optimization), and a code generator (generate render function code from element ASTs). Note the codegen directly generates code strings from the element AST - it's done this way for smaller code size because the compiler is shipped to the browser in the standalone build.
92+
The compiler consists of a parser (converts template strings to element ASTs), an optimizer (detects static trees for vdom render optimization), and a code generator (generate render function code from element ASTs). Note that codegen directly generates code strings from the element AST - it's done this way for smaller code size because the compiler is shipped to the browser in the standalone build.
9393

9494
- **`core`**: contains universal, platform-agnostic runtime code.
9595

96-
The Vue 2.0 core is platform-agnostic - which means code inside `core` should be able to run in any JavaScript environment, be it the browser, Node.js, or an embedded JavaScript runtime in native applications.
96+
The Vue 2.0 core is platform-agnostic. That is, code inside `core` is able to be run in any JavaScript environment, be it the browser, Node.js, or an embedded JavaScript runtime in native applications.
9797

9898
- **`observer`**: contains code related to the reactivity system.
9999

100100
- **`vdom`**: contains code related to vdom element creation and patching.
101101

102102
- **`instance`**: contains Vue instance constructor and prototype methods.
103103

104-
- **`global-api`**: as the name suggests.
104+
- **`global-api`**: contains Vue global api.
105105

106-
- **`components`**: universal abstract components. Currently `keep-alive` is the only one.
106+
- **`components`**: contains universal abstract components.
107107

108108
- **`server`**: contains code related to server-side rendering.
109109

110110
- **`platforms`**: contains platform-specific code.
111111

112112
Entry files for dist builds are located in their respective platform directory.
113113

114-
Each platform module contains three parts: `compiler`, `runtime` and `server`, corresponding to the three directories above. Each part contains platform-specific modules/utilities which are then imported and injected to the core counterparts in platform-specific entry files. For example, the code implementing the logic behind `v-bind:class` is in `platforms/web/runtime/modules/class.js` - which is imported in `entries/web-runtime.js` and used to create the browser-specific vdom patching function.
114+
Each platform module contains three parts: `compiler`, `runtime` and `server`, corresponding to the three directories above. Each part contains platform-specific modules/utilities which are imported and injected to the core counterparts in platform-specific entry files. For example, the code implementing the logic behind `v-bind:class` is in `platforms/web/runtime/modules/class.js` - which is imported in `entries/web-runtime.js` and used to create the browser-specific vdom patching function.
115115

116116
- **`sfc`**: contains single-file component (`*.vue` files) parsing logic. This is used in the `vue-template-compiler` package.
117117

118118
- **`shared`**: contains utilities shared across the entire codebase.
119119

120120
- **`types`**: contains TypeScript type definitions
121121

122-
- **`test`**: type definitions tests
122+
- **`test`**: contains type definitions tests
123123

124124

125125
## Financial Contribution
126126

127-
As a pure community-driven project without major corporate backing, we also welcome financial contributions via Patreon or OpenCollective.
127+
As a pure community-driven project without major corporate backing, we also welcome financial contributions via Patreon and OpenCollective.
128128

129129
- [Become a backer or sponsor on Patreon](https://www.patreon.com/evanyou)
130130
- [Become a backer or sponsor on OpenCollective](https://opencollective.com/vuejs)
131131

132-
### What's the difference between Patreon and OpenCollective?
132+
### What's the difference between Patreon and OpenCollective funding?
133133

134134
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.
135135

0 commit comments

Comments
 (0)