追加: CONTRIBUTING.md リリース

[tarepan]

内容

README.md と CONTRIBUTING.md の重複を削除し、CONTRIBUTING.md を公式リリース（工事中 の削除）する。

関連 Issue

resolve #686 (final step 🎉)

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	513	218
voicevox_engine/init.py	1	0
voicevox_engine/cancellable_engine.py	94	72
voicevox_engine/core/init.py	0	0
voicevox_engine/core/core_adapter.py	81	12
voicevox_engine/core/core_initializer.py	60	30
voicevox_engine/core/core_wrapper.py	225	157
voicevox_engine/dev/init.py	0	0
voicevox_engine/dev/core/init.py	0	0
voicevox_engine/dev/core/mock.py	65	4
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	12	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	71	4
voicevox_engine/preset/Preset.py	13	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	80	2
voicevox_engine/preset/init.py	0	0
voicevox_engine/setting/Setting.py	11	0
voicevox_engine/setting/SettingLoader.py	17	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	267	9
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	2438	549

[Hiroshiba]

すみません、ちょっとリリースするにはCONTRIBUTING.mdのリファクタリングがもうちょっと必要かなと思いました！

まだパッと見ただけですが気になった点を列挙してみます 🙇

• フォーマットされてない
• 表記ゆれ（VOICEVOX/voicevox）
• ####の数がおかしいときがありそう
• 「インストール」項目でインストール案内していない（多分言いたいことは「環境構築」）
• 「セットアップ」項目がかなり説明不足（「以下のコマンドで使用できるようになります。」で何が使用できるのかがわからない、とか）

あとREADMEから削除されてる部分で、このリポジトリをフォークして使う方向けの案内は残しておくと良いかもと思いました！
具体的には多分これだけ

• 製品版のビルド方法
• Github Actions周り（ビルド方法・変数の指定）
• ライセンス周り

「詳しくは貢献者ガイドラインをご覧ください」とかでも問題ないかもです！

[tarepan]

現状

#1215 により大幅ブラッシュアップが完了した。よって CONTRIBUTING.md 自体は正式リリース可能である。リリース時には工事中表記を外す必要がある。
全体としてみると、リリースまでに最後の詰めが必要である。具体的には README.md と CONTRIBUTING.md の重複がある。

対処

README.md 側の重複分を簡略化して案内とリンクへ置き換える。これにより重複を解消する。
重複を解消してもなお分量が多いため、各ガイドへの目次を冒頭へ追加する。
それと同時に CONTRIBUTING.md の工事中表記を削除する。
これにより CONTRIBUTING.md が正式リリースとなる。

---

@Hiroshiba
最終 PR が完成しました。レビューよろしくお願いします。

[Hiroshiba]

ほぼLGTMです！！

すみませんお待たせしました！！

[tarepan]

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

[Hiroshiba]

LGTM！！

１箇所だけ変えて、こちらでフォーマットしてマージします！！

すごく丁寧な玄関ができたと思います！！ありがとうございました！！！！！！！！！！

[Hiroshiba]

@tarepan あ、１つご相談が！

ニーズのある機能が実装されたときにSNSで言及しておりまして、今回のプルリクエストもツイートしたいと思っています。
https://x.com/search?q=%23VOICEVOX%E9%96%8B%E7%99%BA%E7%8A%B6%E6%B3%81
もしよかったらそこで @tarepan さんのXアカウントをツイート文に含めて紹介させていただきたいのですが、構わないでしょうか･･･？

こんな感じを予定しています･･･！

#VOICEVOX開発状況 
VOICEVOXエンジンの貢献者ガイドラインができました🎉
プルリクエストレビューの流れやビルド方法まで一通り紹介しています。
ガイドラインはこちら↓
https://github.com/VOICEVOX/voicevox_engine/blob/main/CONTRIBUTING.md
【開発者: @tarepan_mhhow】
https://github.com/VOICEVOX/voicevox_engine/pull/1119

[tarepan]

紹介させていただきたいのですが、構わないでしょうか

OKです👍️