Skip to content

Commit f633cc8

Browse files
committed
Update contribution guide
1 parent 2c2d5ee commit f633cc8

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,15 @@ Welcome to the Vue Testing Handbook!
88

99
This is a collection of short, focused examples on how to test Vue components. It uses `vue-test-utils`, the official library for testing Vue components, and Jest, a modern testing framework. It covers the `vue-test-utils` API, as well as best practises and useful parts of the Jest API for testing Vue components, as well an a demo project with all the example code.
1010

11+
## Style
12+
1113
Most sections have have a simple component or two, some tests, and the related code. Here is an example
1214

13-
- [Setting up for TDD](https://github.com/lmiller1990/vue-testing-handbook/blob/master/docs/setting-up-for-tdd.md)
14-
- [Component](https://github.com/lmiller1990/vue-testing-handbook/blob/master/demo-app/src/components/Greeting.vue)
15-
- [Test](https://github.com/lmiller1990/vue-testing-handbook/blob/master/demo-app/tests/unit/Greeting.spec.js)
15+
- [Setting up for TDD](https://github.com/lmiller1990/vue-testing-handbook/blob/master/docs/setting-up-for-tdd.md). This is a guide about setting up an environment for TDD.
16+
- [Component](https://github.com/lmiller1990/vue-testing-handbook/blob/master/demo-app/src/components/Greeting.vue). This is the component usd in the guide.
17+
- [Test](https://github.com/lmiller1990/vue-testing-handbook/blob/master/demo-app/tests/unit/Greeting.spec.js). This is the test used in the guide.
18+
19+
Guides should be short, concise, and focused on a single concept. The relevant code should be linked in the article, and easily reproduced by the reader.
1620

1721
## Languages
1822

@@ -22,21 +26,23 @@ We are aiming to support Japanese and English for now.
2226

2327
### Development enviroment
2428

25-
Clone the repo and run `yarn`. Then run `yarn dev` to open the dev server. Access it on `localhost:8080`.
29+
Vuepress is used to generate the static website. Articles are written in markdown.
2630

27-
There is an example project to run tests and examples. To run it, `cd demo-app`, then run `yarn`. To run the test run `yarn test:unit`.
31+
#### Guides
2832

29-
### Existing pages
33+
Clone the repo and run `yarn` to install the dependencies. Then run `yarn dev` to open the dev server. Access it on `localhost:8080`.
3034

31-
Make an issue regarding what you think can be improved, and why. Once everyone is happy with the addition, add it in English. Someone will translate it so the guide stays in sync for both languages, and it will be merged.
35+
#### Code Samples
3236

33-
### Adding a new page
37+
There is an example project to run tests and examples used in the guides. To run it the demo app, run `cd demo-app` to navigate into the project, then run `yarn` to install the dependencies. Run `yarn test:unit` to execute the test suite.
3438

35-
Make an issue explaining the benefit of the new page. Once everyone is in agreement, add the new page. You should also add an example to the `demo-app` project, so readers can easily recreate the scenario. You should also create a new page for the Japaense documentation, so someone can translate it later. This helps keep the guie up to date.
39+
### Updates existing guides
3640

37-
### Fixing grammar or stylist improvements
41+
Make an issue regarding what you think can be improved, or just make a PR.
3842

39-
Just make the PR.
43+
### Adding a new page
44+
45+
Make an issue explaining the benefit of the new page. You should also add any relevant code and tests in the `demo-app` project, so readers can easily recreate the scenario.
4046

4147
## Vue Testing Handbook
4248

@@ -60,18 +66,14 @@ Most sections have have a simple component or two, some tests, and the related c
6066

6167
### 開発環境
6268

63-
レプをクローンして、`yarn`を実行します. そして`yarn dev`を実行して、`localhost:8080`にアクセスします。
69+
レプをクローンして、`yarn install`を実行して必要なモジュールをインストールします。そして`yarn dev`を実行して、`localhost:8080`にアクセスします。
6470

65-
デモプロジェクトもあります`cd demo-app`して、そして`yarn`を実行してインストールします。`yarn test:unit`でテストを実行します。
71+
ガイドに使うテストのデモプロジェクトもあります`cd demo-app`して、そして`yarn install`を実行してインストールします。`yarn test:unit`でテストを実行します。
6672

6773
### 既存のページに貢献
6874

69-
追加したいことについて課題を作ってください。ディスカッションしてから追加します。もし日本語だけで追加したら、誰かが翻訳してからマージします
75+
Issueを切って、それかPRを出します。レビューします
7076

7177
### 新しいページを追加
7278

73-
課題を作って、新しいページの価値を説明してください。皆さんは賛成すると、新しいページを追加してください。`demo-app`プロジェクトにも書いたコードの例を追加してください。そうすると、ガイドが説明した内容を簡単に再現できます。もし日本語だけで追加すると、英語のページを作って、誰かが翻訳します。
74-
75-
### 文法、スタイルだけの改善
76-
77-
普通にPRを作ってください。
79+
課題を作って、新しいページの価値を説明してください。`demo-app`プロジェクトにも書いたコードの例を追加してください。そうすると、ガイドが説明した内容を簡単に再現できます。

0 commit comments

Comments
 (0)