Skip to content

Commit f94b0b5

Browse files
committed
* e2e部分の追記
* インデント修正
1 parent 26b5b53 commit f94b0b5

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

Diff for: CONTRIBUTING.md

+19-4
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ VITE_DEFAULT_ENGINE_INFOS=`[
214214

215215
### 4. 事前テスト
216216

217+
* 提出前にコードをテストします。テストにはいくつかのツールを使います。このガイドラインの手順で進んでいれば既に必要なものはそろっている
218+
217219
* 記述コードがコーディングルールに沿っていることを確認します。(特に今回の作業によって警告やエラーが増えていないかどうかに注目してください)
218220

219221
```bash
@@ -230,27 +232,40 @@ VITE_DEFAULT_ENGINE_INFOS=`[
230232
* Markdownの記述が正しいことを確認します。
231233

232234
```bash
233-
npm run markdownlint ./*/*.md
235+
npm run markdownlint ./*/*.md
234236
```
235237

236238
* 命名に使っている英語が誤っていないことを確認します。
237239

238240
```bash
239-
typos
241+
typos
240242
```
241243

242244
* 個人環境でVOICEVOXを実行し、提出前に、一通り動くことを確認します。
243245

244246
```bash
245-
npm run electron:serve
247+
npm run electron:serve
246248
```
247249

248250
* 使用するライブラリのライセンスに使用出来ないものが使われていないことを確認します。
249251

250252
```bash
251-
npm run license:generate -- -o voicevox_licenses.json
253+
npm run license:generate -- -o voicevox_licenses.json
254+
```
255+
256+
* e2eテストの内容を確認します。
257+
258+
```bash
259+
npm run test:unit
260+
npm run test:browser-e2e
261+
npm run test:electron-e2e
252262
```
253263

264+
* e2eテストは実際には自分が提出する範囲外の指摘をしたり、完全に警告が消えないことがあります。
265+
* 確認の目安としては、加工前後で e2eテスト結果による指摘が増えていないことを確認してください。(チェックアウト時点でe2eテストの指摘が残っていることがあるため、前後の差分で判断するのが良いでしょう)
266+
* 提出する範囲で指摘されているようであれば提出前に訂正しましょう。
267+
* e2eテスト結果を修正出来ない事情がある場合や判断に迷う場合は、レビュー時に相談をしましょう。
268+
254269
### 5. コードの提出
255270

256271
* 先に個人のリポジトリにコミットします。この時、詳細欄に変更に関する具体内容を確実に記入しましょう。タイトルは簡素で分かりやすいものが好まれます。

0 commit comments

Comments
 (0)