整理: 貢献者ガイド節への集約

[tarepan]

内容

README.md コンテンツのうち、コントリビュータのみに関連する内容を新設の「貢献者ガイド」節へ集約してリファクタリング

コンテンツ変更一切無し、集約のみ

関連 Issue

part of #687

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	481	327
voicevox_engine/init.py	1	0
voicevox_engine/acoustic_feature_extractor.py	19	1
voicevox_engine/cancellable_engine.py	91	71
voicevox_engine/dev/core/init.py	2	0
voicevox_engine/dev/core/mock.py	27	12
voicevox_engine/dev/synthesis_engine/init.py	2	0
voicevox_engine/dev/synthesis_engine/mock.py	38	2
voicevox_engine/engine_manifest/EngineManifest.py	34	0
voicevox_engine/engine_manifest/EngineManifestLoader.py	12	0
voicevox_engine/engine_manifest/init.py	3	0
voicevox_engine/full_context_label.py	162	3
voicevox_engine/kana_parser.py	86	1
voicevox_engine/library_manager.py	93	5
voicevox_engine/metas/Metas.py	33	0
voicevox_engine/metas/MetasStore.py	29	12
voicevox_engine/metas/init.py	2	0
voicevox_engine/model.py	162	9
voicevox_engine/mora_list.py	4	0
voicevox_engine/morphing.py	70	46
voicevox_engine/part_of_speech_data.py	5	0
voicevox_engine/preset/Preset.py	12	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	81	2
voicevox_engine/preset/init.py	4	0
voicevox_engine/setting/Setting.py	11	0
voicevox_engine/setting/SettingLoader.py	19	0
voicevox_engine/setting/init.py	3	0
voicevox_engine/synthesis_engine/init.py	5	0
voicevox_engine/synthesis_engine/core_wrapper.py	202	147
voicevox_engine/synthesis_engine/make_synthesis_engines.py	59	30
voicevox_engine/synthesis_engine/synthesis_engine.py	172	13
voicevox_engine/synthesis_engine/synthesis_engine_base.py	71	10
voicevox_engine/user_dict.py	144	12
voicevox_engine/utility/init.py	5	0
voicevox_engine/utility/connect_base64_waves.py	37	0
voicevox_engine/utility/core_version_utility.py	8	1
voicevox_engine/utility/mutex_utility.py	10	0
voicevox_engine/utility/path_utility.py	26	8
TOTAL	2227	712

[Hiroshiba]

並び替え良いですね！！！

貢献者向けの情報って、実行やビルドの方法も書いていたほうが嬉しかったりしそうでしょうか？
なんとなくVueJSのガイドライン見た感じそんななのかな〜と！！
https://github.com/vuejs/core/blob/main/.github/contributing.md

[tarepan]

実行やビルドの方法も書いていたほうが

はい、ビルド・実行の情報も（初回コントリビュート時に）欲しい情報でした。

しかし、これらの情報を貢献者ガイドへ組み入れると「開発者に伝わらない恐れ」というデメリットが出てきます。

voicevox_engine レポジトリには主に3通りの利用者・用途があります：

• User ソフトウェアユーザー: ビルド済み VOICEVOX ENGINE ソフトウェアの利用ガイド
• Dev 開発者: VOICEVOX マルチエンジン開発出発点
• Contrib コントリビューター: 改良対象

ビルド・実行の手順情報は User に不要な一方、Dev と Contrib には必須です。
そして Dev にとって「voicevox_engine への貢献方法」は知る必要の無い情報です。
よって Dev は貢献者ガイドを（とりあえず）読み飛ばす可能性が高いです。

ゆえにビルド・実行の手順を貢献者ガイドへ入れてしまうと、Dev が必要な情報にたどり着けないリスクを上げてしまいます。

コントリビュータはREADMEを一通り読むと考えると、貢献者ガイド節より前にビルド・実行の手順が書いてあれば最低限情報は伝わる気がします。
PR作成時にREADMEをスクロールして「どこだったっけ…？」とするのは確かに不便なので、貢献者ガイド内にビルド・実行節へのリンクを貼るのは手かもしれません。

[Hiroshiba]

@tarepan なるほどです！
VOICEVOXの人数バランス的に、マルチエンジンを作る人よりもコントリビューターの方が圧倒的に多いので、そちらにUXを合わせるのが良いのかなと思いました！
ただまあコントリビューター・マルチエンジン開発者どちらにも必要な情報というのはあると思うので、そこの案内をどうするかは確かに考える必要があるかなと思いました。

コントリビューターのところに実行や環境構築やビルドの方法を書いちゃって、マルチエンジン実装方法を紹介するとこに「VOICEVOXエンジンの実行方法は貢献者ガイドラインの～～にあります」と案内するのはどうでしょう？

[tarepan]

VOICEVOXの人数バランス ... コントリビューターの方が圧倒的に多い

納得です。

マルチエンジン実装方法を紹介するとこに「VOICEVOXエンジンの実行方法は貢献者ガイドラインの～～にあります」と案内

👍
こちらの方針で draft PR を再整理し、正式PR化します。

[Hiroshiba]

LGTM！！！

挑戦ありがとうございました！！