docs: contributing guidelines

diff --git a/.github/commit-convention.md b/.github/commit-convention.md
index e4d2eb56c395918524518656fc3575a9d3810d3c..9e02c138ad8c2ded939e59b5f83d6dc2f17e9eab 100644 (file)
--- a/.github/commit-convention.md
+++ b/.github/commit-convention.md
@@ -12,16 +12,16 @@ Messages must be matched by the following regex:
 
 #### Examples
 
-Appears under "Features" header, `compiler` subheader:
+Appears under "Features" header, `link` subheader:
 
 ```
-feat(compiler): add 'comments' option
+feat(link): add `force` option
 ```
 
-Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue #28:
+Appears under "Bug Fixes" header, `view` subheader, with a link to issue #28:
 
 ```
-fix(v-model): handle events on blur
+fix(view): handle keep-alive with aborted navigations
 
 close #28
 ```
@@ -29,9 +29,9 @@ 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
+perf: improve guard extraction
 
-BREAKING CHANGE: The 'foo' option has been removed.
+BREAKING CHANGE: The 'beforeRouteEnter' 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.

diff --git a/.github/contributing.md b/.github/contributing.md
index c3b60a8a9db937d32ac7706ff5b32be9b7834626..acb811bd86e67dae0b24d03b1976b34bdd5ca478 100644 (file)
--- a/.github/contributing.md
+++ b/.github/contributing.md
@@ -87,78 +87,6 @@ $ yarn jest --watch
 
 ## Project Structure
 
-This repository employs a [monorepo](https://en.wikipedia.org/wiki/Monorepo) setup which hosts a number of associated packages under the `packages` directory:
-
-- `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.
-
-- `template-explorer`: A development tool for debugging compiler output. You can run `yarn dev template-explorer` and 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.
-
-### Importing Packages
-
-The packages can import each other directly using their package names. Note that when importing a package, the name listed in its `package.json` should be used. Most of the time the `@vue/` prefix is needed:
-
-```js
-import { h } from '@vue/runtime-core'
-```
-
-This is made possible via several configurations:
-
-- For TypeScript, `compilerOptions.path` in `tsconfig.json`
-- For Jest, `moduleNameMapper` in `jest.config.js`
-- For plain Node.js, they are linked using [Yarn Workspaces](https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/).
-
-### Package Dependencies
-
-```
-
-                                    +---------------------+
-                                    |                     |
-                                    |  @vue/compiler-sfc  |
-                                    |                     |
-                                    +-----+--------+------+
-                                          |        |
-                                          v        v
-                      +---------------------+    +----------------------+
-                      |                     |    |                      |
-        +------------>|  @vue/compiler-dom  +--->|  @vue/compiler-core  |
-        |             |                     |    |                      |
-   +----+----+        +---------------------+    +----------------------+
-   |         |
-   |   vue   |
-   |         |
-   +----+----+        +---------------------+    +----------------------+    +-------------------+
-        |             |                     |    |                      |    |                   |
-        +------------>|  @vue/runtime-dom   +--->|  @vue/runtime-core   +--->|  @vue/reactivity  |
-                      |                     |    |                      |    |                   |
-                      +---------------------+    +----------------------+    +-------------------+
-```
-
-There are some rules to follow when importing across package boundaries:
-
-- Never use direct relative paths when importing items from another package - export it in the source package and import it at the package level.
-
-- Compiler packages should not import items from the runtime, and vice versa. If something needs to be shared between the compiler-side and runtime-side, it should be extracted into `@vue/shared` instead.
-
-- If a package (A) has a non-type import from another package (B), package (B) should be listed as a dependency in the `package.json` of package (A). This is because the packages are externalized in the ESM-bundler/CJS builds and type declaration files, so the dependency packages must be actually installed as a dependency when consumed from package registries.
-
 ## Contributing Tests
 
 Unit tests are located inside `__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: