Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.mdの整備 #687

Merged
merged 9 commits into from
Feb 28, 2024
Merged

CONTRIBUTING.mdの整備 #687

merged 9 commits into from
Feb 28, 2024

Conversation

misogihagi
Copy link
Contributor

関連 Issue

#686

@misogihagi misogihagi requested a review from a team as a code owner May 23, 2023 16:41
@misogihagi misogihagi requested review from y-chan and removed request for a team May 23, 2023 16:41


## Issue
不具合の報告、機能要望、改善提案、質問は<a href="https://github.com/VOICEVOX/voicevox_engine/issues/new">Issue</a>の方に報告してください。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここはContributingに乗っけるのは少し変な気がしました。

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ルートにCONTRIBUTING.mdをおくと特別扱いされる(はず)のでそっちに移動してもいいかもしれません

@sevenc-nanashi
Copy link
Member

また、READMEと被る内容がかなりあるので、

  • READMEには実行向けのもの(実行セクションとか?)
  • CONTRIBUTINGには開発向けのもの(ビルドや環境構築)
    みたいに分けるべきだと思いました。

@github-actions
Copy link

github-actions bot commented May 23, 2023

Coverage Result

Resultを開く
Name Stmts Miss Cover
run.py 513 272 coverage-47%
voicevox_engine/init.py 1 0 coverage-100%
voicevox_engine/cancellable_engine.py 94 72 coverage-23%
voicevox_engine/core/init.py 0 0 coverage-100%
voicevox_engine/core/core_adapter.py 81 12 coverage-85%
voicevox_engine/core/core_initializer.py 59 30 coverage-49%
voicevox_engine/core/core_wrapper.py 257 183 coverage-29%
voicevox_engine/dev/init.py 0 0 coverage-100%
voicevox_engine/dev/core/init.py 0 0 coverage-100%
voicevox_engine/dev/core/mock.py 65 4 coverage-94%
voicevox_engine/dev/tts_engine/init.py 0 0 coverage-100%
voicevox_engine/dev/tts_engine/mock.py 28 0 coverage-100%
voicevox_engine/engine_manifest/EngineManifest.py 36 0 coverage-100%
voicevox_engine/engine_manifest/EngineManifestLoader.py 12 0 coverage-100%
voicevox_engine/engine_manifest/init.py 0 0 coverage-100%
voicevox_engine/library_manager.py 92 4 coverage-96%
voicevox_engine/metas/Metas.py 36 0 coverage-100%
voicevox_engine/metas/MetasStore.py 28 6 coverage-79%
voicevox_engine/metas/init.py 0 0 coverage-100%
voicevox_engine/model.py 180 9 coverage-95%
voicevox_engine/morphing.py 71 46 coverage-35%
voicevox_engine/preset/Preset.py 13 0 coverage-100%
voicevox_engine/preset/PresetError.py 2 0 coverage-100%
voicevox_engine/preset/PresetManager.py 80 2 coverage-98%
voicevox_engine/preset/init.py 0 0 coverage-100%
voicevox_engine/setting/Setting.py 11 0 coverage-100%
voicevox_engine/setting/SettingLoader.py 17 0 coverage-100%
voicevox_engine/setting/init.py 0 0 coverage-100%
voicevox_engine/tts_pipeline/init.py 0 0 coverage-100%
voicevox_engine/tts_pipeline/kana_converter.py 88 1 coverage-99%
voicevox_engine/tts_pipeline/mora_mapping.py 7 0 coverage-100%
voicevox_engine/tts_pipeline/phoneme.py 34 0 coverage-100%
voicevox_engine/tts_pipeline/text_analyzer.py 146 6 coverage-96%
voicevox_engine/tts_pipeline/tts_engine.py 267 9 coverage-97%
voicevox_engine/user_dict/part_of_speech_data.py 5 0 coverage-100%
voicevox_engine/user_dict/user_dict.py 146 12 coverage-92%
voicevox_engine/utility/init.py 0 0 coverage-100%
voicevox_engine/utility/connect_base64_waves.py 37 0 coverage-100%
voicevox_engine/utility/core_version_utility.py 8 1 coverage-88%
voicevox_engine/utility/mutex_utility.py 13 0 coverage-100%
voicevox_engine/utility/path_utility.py 26 6 coverage-77%
voicevox_engine/utility/run_utility.py 10 7 coverage-30%
TOTAL 2463 682 coverage-72%

Copy link
Contributor

@tarepan tarepan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

👍 インストールから commit まで一連の流れをガイドしており、貢献者がコケづらい良いCONTRIBUTING.md です。
README.md との重複や deprecated な記述があるため、これを基礎として一旦 merge し、後続の PR で更に改善するのが適切そうです。
good work!

issue #686 に関しては close せず、引き続き track するのが適切に感じます。

@Hiroshiba
こちら review 可能です。

@Hiroshiba
Copy link
Member

これを基礎として一旦 merge し、後続の PR で更に改善するのが適切そうです。

なるほどです!
一瞬未完成なコントリビューションガイドラインが現れることになると思うので、ガイドラインの一番上に何かしらのアナウンスがあるといいのかもと思いました!
ちょっと提案してみます!

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>
Copy link
Contributor

@tarepan tarepan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • タイポ(typos でチェック可能)

Co-authored-by: tarepan <tarepan5884@gmail.com>
Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

@tarepan さんがapproveしたらマージ可能になると思います。
なのでマージしていただければ!

Copy link
Contributor

@tarepan tarepan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tarepan tarepan merged commit 943744d into VOICEVOX:master Feb 28, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants