Skip to content

Commit

Permalink
提案いただいた分のコミットと追記
Browse files Browse the repository at this point in the history
  • Loading branch information
nmori committed Jun 2, 2024
1 parent f94b0b5 commit bea5660
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
実際に参加しようとすると、どんなコミュニティにもルールが存在し、そこを理解しないとハードルを高く感じてしまうこと
があります。

このガイドラインは、その部分を出来るだけ分かりやすく文章として残し、コミュニティへ参画しやすい環境を提供するために執筆されました。
このガイドラインは、その部分を出来るだけ分かりやすく文章として残し、コミュニティへ参画しやすい環境を提供するために執筆されました。なお、新たな貢献者が参入しやすくするよう、細かく解説しているため、慣れている方には不要な説明も含まれます。プロジェクトは意志ある貢献者を歓迎しておりますので、ドキュメントを読んで参画してみてくささい。

## 担当

|役割 | 担当 |
|-----------------|-----------------------|
|プロダクトオーナ |@Hiroshiba |
|メンテナー |@Hiroshiba@y-chan |
|プロダクトオーナー |@Hiroshiba |
|メンテナー |@Hiroshiba@y-chan@qryxip |

## 参加の心得

Expand Down Expand Up @@ -74,7 +74,7 @@ VOICEVOXには、下記のような貢献の仕方があります。

### 1. 製品版VOICEVOXを導入する

* まず[VOICEVOXの製品版](https://voicevox.hiroshiba.jp/)を導入します。これによりすぐ使えるVOIECVOXエンジンを手に入れることができます。
* まず[VOICEVOXの製品版](https://voicevox.hiroshiba.jp/)を導入します。これによりすぐ使えるVOIECVOXエンジンを手に入れることができます。

### 2. 開発環境の構築

Expand Down Expand Up @@ -127,7 +127,7 @@ git clone [email protected]:(個人のGitHubアカウント名)/voicevox.git
* `.env.production`というファイルがありますので、コピーして、名前を`.env`にします。
* ファイルをエディタでひらいて、`VITE_DEFAULT_ENGINE_INFOS`内の`executionFilePath`に手順1のフォルダ名をいれます。たとえば製品版をインストーラで導入し、インストール先を変更していない場合は、下記のように書き換えて保存します。

```text
```ini
VITE_APP_NAME=voicevox
VITE_DEFAULT_ENGINE_INFOS=`[
{
Expand All @@ -144,23 +144,23 @@ VITE_DEFAULT_ENGINE_INFOS=`[
* あなたがVOICEVOX製品版のインストール先を変更している場合は個別で指定します。たとえば、`D:\VOICEVOX0.14.1`に製品版をインストールしている場合は、下記のように書き換えて保存します。

```text
"executionFilePath": "D:/VOICEVOX0.14.1/run.exe",
"executionFilePath": "D:/VOICEVOX0.14.1/vv-engine/run.exe",
```

### 7. 始動してみる

* `npm run electron:serve`を実行します。
* 設定が正しければ、開発環境が起動するはずです。

## 作業手順
## プロジェクトへの貢献手順

### 1. 提案と調整

まず、下記のことがあれば、Issueとして登録をしましょう。

* プログラムの仕様を変更したい
* 新機能を追加したい
* バグを確認した
* バグを確認した

#### 1.1 提案

Expand Down Expand Up @@ -308,29 +308,25 @@ VITE_DEFAULT_ENGINE_INFOS=`[

* この段階では、既にPull Requestが出されていますので、自分のリポジトリに修正分をプッシュするだけで自動的に追跡されます。

* 現在のVOICEVOXのマージルールでは、基本的に2名以上の査読が必要となっています
* 現在のVOICEVOXのマージルールでは、基本的に1名以上の査読が必要となっています

### 7. コンフリクト対応

* レビューが終ると、マージ(取り込み)準備が始まります。

* 作業中に他の修正が取り込まれている場合には、修正箇所が重なる「コンフリクト」という現象が発生します。

* コンフリクトが発生した場合には、Pull Requestの議論ページに「コンフリクトが発生している」と表示されるので、次の手順で修正を行います。

1. 自分の作業リポジトリにプルします。プル元は、自分のGitHub領域ではなく、[VOICEVOXのリポジトリ](https://github.com/VOICEVOX/voicevox.git)を指定します。
* 作業中に他の修正が取り込まれている場合には、修正箇所が重なる「コンフリクト」という現象が発生することがあります。

2. 自分の作業リポジトリにプッシュします。この時、「コンフリクトが発生した」と表示されますが、そのまま続行します
* コンフリクトが発生した場合には、Pull Requestのページに「コンフリクトが発生している」と表示されるので、次の手順で修正を行います

3. 変更差分をみながら、修正がぶつかっている部分を正しい実装に修正します
1. 自分の作業リポジトリにプルします。プル元は、自分のGitHubリポジトリではなく、[VOICEVOXのリポジトリ](https://github.com/VOICEVOX/voicevox.git)を指定します

4. 変更がすべて終わったら、手順4にあった「事前テスト」を改めて実施します
2. 変更差分をみながら、コンフリクトしている部分を正しい実装に修正します

5. 問題なければ、コミットします
3. 変更がすべて終わったら、手順4にあった「事前テスト」を改めて実施します

6. VOICEVOXのPull Request議論ページで自動検査処理が走ります。この画面で「コンフリクトが発生した」という表示が消えたことを確認してください
4. 問題なければ、コミットします

### 8. マージ処理
5. VOICEVOXのPull Requestページで自動検査処理が走ります。この画面で「コンフリクトが発生した」という表示が消えたことを確認してください。

* お疲れさまでした。この工程までいけば、貢献者の仕事はおわりです。
* マージ担当者が確認後、マージ処理をします。
Expand Down

0 comments on commit bea5660

Please sign in to comment.