Skip to content

Commit ae5dddd

Browse files
committed
Contribution guide in the docs
1 parent 8bc576a commit ae5dddd

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

docs/.vuepress/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ themeConfig:
3333
- /guide/meta-fields/
3434
- /guide/testing/
3535
- /guide/faq/
36+
- /guide/contribution/

docs/guide/contribution/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contribution
2+
3+
[[toc]]
4+
5+
To test this plugin in your existing project, you can use `yarn link` functionality. Run `yarn link`
6+
in your local plugin-graphql directory and run `yarn link @vuex-orm/plugin-graphql` in your project dir.
7+
8+
Remember to run `yarn build` in your plugin-graphql directory and then again `yarn link` in your project after you have
9+
made changes to the plugin code. You probably have also to restart your webpack server.
10+
11+
12+
```bash
13+
$ yarn run build
14+
```
15+
16+
Compile files and generate bundles in dist directory.
17+
18+
```bash
19+
$ yarn run lint
20+
```
21+
22+
Lint files using a rule of Standard JS.
23+
24+
```bash
25+
$ yarn run test
26+
```
27+
28+
Run the test using Mocha Webpack.
29+
30+
```bash
31+
$ yarn run coverage
32+
```
33+
34+
Generate test coverage in coverage directory.
35+
36+
37+
```bash
38+
yarn docs:build
39+
```
40+
41+
Builds the documentation.
42+
43+
44+
```bash
45+
yarn docs:dev
46+
```
47+
48+
Spawns a server for the documentation.
49+
50+
51+
```bash
52+
yarn docs:depoy
53+
```
54+
55+
Deploys the documentation.

0 commit comments

Comments
 (0)