整理: CONTRIBUTING.md 明確化

[tarepan]

内容

CONTRIBUTING.md の記述を明確化してリファクタリングした。

#686 での指摘点を 1点 1 commit で改善しました。
review の際はご活用ください。

関連 Issue

part of #686

Notes

追記: 以下の方針は採用するか未定 #686 でフォーマッタ指定が成されたのち、フォーマッタをかけて commit。その後に review 可能。

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	277	122
voicevox_engine/init.py	1	0
voicevox_engine/app/init.py	0	0
voicevox_engine/app/dependencies.py	9	0
voicevox_engine/app/routers/init.py	0	0
voicevox_engine/app/routers/preset.py	37	4
voicevox_engine/app/routers/setting.py	24	3
voicevox_engine/app/routers/speaker.py	59	5
voicevox_engine/app/routers/tts_pipeline.py	125	29
voicevox_engine/app/routers/user_dict.py	60	29
voicevox_engine/cancellable_engine.py	97	75
voicevox_engine/core/init.py	0	0
voicevox_engine/core/core_adapter.py	81	6
voicevox_engine/core/core_initializer.py	60	30
voicevox_engine/core/core_wrapper.py	228	160
voicevox_engine/dev/init.py	0	0
voicevox_engine/dev/core/init.py	0	0
voicevox_engine/dev/core/mock.py	65	2
voicevox_engine/dev/tts_engine/init.py	0	0
voicevox_engine/dev/tts_engine/mock.py	28	0
voicevox_engine/engine_manifest/EngineManifest.py	36	0
voicevox_engine/engine_manifest/EngineManifestLoader.py	11	0
voicevox_engine/engine_manifest/init.py	0	0
voicevox_engine/library_manager.py	92	4
voicevox_engine/metas/Metas.py	36	0
voicevox_engine/metas/MetasStore.py	28	1
voicevox_engine/metas/init.py	0	0
voicevox_engine/model.py	180	3
voicevox_engine/morphing.py	72	4
voicevox_engine/preset/Preset.py	13	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	82	2
voicevox_engine/preset/init.py	0	0
voicevox_engine/setting/Setting.py	9	0
voicevox_engine/setting/SettingLoader.py	20	0
voicevox_engine/setting/init.py	0	0
voicevox_engine/tts_pipeline/init.py	0	0
voicevox_engine/tts_pipeline/kana_converter.py	88	1
voicevox_engine/tts_pipeline/mora_mapping.py	7	0
voicevox_engine/tts_pipeline/phoneme.py	34	0
voicevox_engine/tts_pipeline/text_analyzer.py	146	6
voicevox_engine/tts_pipeline/tts_engine.py	288	12
voicevox_engine/user_dict/part_of_speech_data.py	5	0
voicevox_engine/user_dict/user_dict.py	146	12
voicevox_engine/utility/init.py	0	0
voicevox_engine/utility/connect_base64_waves.py	37	0
voicevox_engine/utility/core_utility.py	6	0
voicevox_engine/utility/core_version_utility.py	8	1
voicevox_engine/utility/mutex_utility.py	13	0
voicevox_engine/utility/path_utility.py	26	6
voicevox_engine/utility/run_utility.py	10	7
TOTAL	2546	524

[Hiroshiba]

変更ありがとうございます！！

こういう入り口部分のドキュメントってとても大事なので、しっかり案内を書いておいてあげたい気持ちが少しあります。
それ待ってちょっと色々コメントさせていただきました 🙇

[tarepan]

@Hiroshiba
全指摘箇所の反映・テストパスを確認しました。Re-review よろしくお願いします。

[Hiroshiba]

すみません、ちょっと2点相談です 🙇

[tarepan]

@Hiroshiba
全指摘箇所の反映・テストパスを確認しました。Re²-review よろしくお願いします。

[Hiroshiba]

LGTM！！

こちらでフォーマッターかけます！

[Hiroshiba]

mockでの起動方法を説明してから音声ライブラリを指定する場合の方法を説明すると、とりあえず起動だけしたい人に優しいかもですね！