貢献者ガイドラインの作成 #1202

nmori · 2023-02-12T03:09:53Z

内容

#1190 で会話を進めている貢献者ガイドラインについて
具体的に文章化したので、内容についてブラッシュアップできればと思います。

スクリーンショット・動画など

その他

・追加されたエンジンが未対応である場合には追加を阻止・追加されてしまっている場合には、エラーで処理中断しないように

・MinimumEngineManifestの更新

・engineManifests[selectedId]自体が undefined であるケースに対応

sevenc-nanashi

とりあえず今見て思ったことをレビューしました。
CONTRIBUTING.mdに書くとPR時に右に出るなど色々な特別扱いがされるので、そっちでもよさそう？（それかCONTRIBUTING.mdにdocsの目次的なのを置くか）

docs/貢献者ガイドライン.md

…cevox into 貢献者ガイドラインVOICEVOX#1190

Hiroshiba · 2023-02-13T11:02:24Z

あ、修正した点からResolveしていって頂けると･･･！（今回はコメントが多いので特に･･･！）

nmori · 2023-02-13T13:11:03Z

解決ボタンを押していけば良いのですね。
了解しました(これもまた追記しますね)

nmori · 2023-02-14T14:34:58Z

CONTRIBUTING.md　の部分は　皆さんのご希望はありますか？
おそらく、
・作業手順はこちらを確認してね
・可能ならば開発に参加してみてください
みたいなことを簡潔に書いておくといい感じでしょうか。

Hiroshiba · 2023-02-14T14:48:01Z

とりあえず、今書いてくださってるのをCONTRIBUTING.mdとするか、なにもしないかで良いかなと思いました！
個人的には、面白そうなので今のガイドラインをCONTRIBUTING.mdとするのもありかなと思いました！！

y-chan · 2023-02-17T10:31:11Z

今のガイドラインをCONTRIBUTING.md

これが良いと思います。
GitHubの機能を全面的に使っていきましょう:muscle:

nmori · 2023-02-17T19:04:04Z

CONTRIBUTING.md　として配置してみました。

《残件》

SSH経由アクセスのコマンドの確認と記載修正
README重複分の整理
誰かに歩んでもらってこれでよいか試してみる(optional)

nmori · 2023-02-18T04:40:17Z

ちなみに、「Issueを閉じるタイミング」を記載していませんが、
これは「マージされたときに、それを確認した提案者が閉じる」でよかったですか？
（ガイドラインの末尾にかいたほうがいいかなぁと）

sevenc-nanashi · 2023-02-18T05:01:32Z

PRの説明にclose #xxxを載せて、で良いと思います（そうするとマージ時に自動で閉じられる）

CONTRIBUTING.md

* フォーマットの修正

Hiroshiba · 2023-12-05T03:05:15Z

おお、ぜひぜひ･･･！
不明な点があればなんでも聞いてください！！

* WIPに付いてのトーンを弱めに。 * リンク切れの修正 *　「その他」の追記

nmori · 2023-12-10T09:39:17Z

ひとまず前回のレビュー分＋αを書き進めました。
数ヶ月で状況が変わっている部分もあるかもしれませんので
レビュー頂ければ幸いです

Hiroshiba · 2023-12-12T15:58:32Z

@nmori ありがとうございます！！

@sevenc-nanashi さん、 @sabonerune さん、もしよかったら気になる点などあればコメントいただけると心強いです･･･！
（@sevenc-nanashi さんはいろんなOSSをご存知で知見が深そうなのと、 @sabonerune さんは細かいことに目を向けた開発者目線を持っていらっしゃるのでお尋ねしてみました･･･！）

sevenc-nanashi

内容は大丈夫だと思います！あとは実際に誰かが辿るのを待ってそれから改善してくのがいいかと。

CONTRIBUTING.md

sabonerune · 2023-12-13T11:48:44Z

ユニットテストやe2eテストについても書いた方がいいような気がしました。

nmori · 2023-12-17T16:44:45Z

ユニットテストやe2eテストについても書いた方がいいような気がしました。

おそらくこのPRログの真上にあるチェック工程に関する話だと思いますが
具体的に貢献者は何を気にして、どのような行動を行えばよいでしょう？

・上のテストがどのようになればよいか
・コミット／査読前にこのチェックを掛けられる方法の有無
・どの状態が修正対応が必要で、どの状態は警告を無視してもよいのか

について、教えて頂けると助かります

sabonerune · 2023-12-18T13:22:45Z

・上のテストがどのようになればよいか

可能な限り全て合格する。

・コミット／査読前にこのチェックを掛けられる方法の有無

ユニットテスト: npm run test:unit
ブラウザe2e: npm run test:browser-e2e
electron e2e: npm run test:electron-e2e

・どの状態が修正対応が必要で、どの状態は警告を無視してもよいのか

エラーが発生した場合原因を特定して修正することが望ましい。
ただしe2eテストは不安定で失敗することが多いので失敗の原因が変更によるものでないのなら無視してもよい。

軽く書いて思ったのですが分かりやすく書くことが難しそうな気がしてきました。

nmori · 2023-12-18T13:34:57Z

ありがとうございます。
このドキュメント記述だけでも e2eがエラーになっていたりするので
実際の判断基準として　どう行動して良いか迷ってしまうことがあります。

表現の提案として

①編集前に e2eテストをかけて、出ているエラー状況を把握する
②実際に提出しようとしていたコードに e2eをかけて、結果の差を見る
　（特にプログラムの修正部位に応じて、テスト範囲はつかいわける）
③エラーが出ていても①と②に差異がなければ、あまり気にしなくて良い
　（その辺はコード提出後のレビューのあたりで相談と判断をすすめる）

ぐらいの感じであれば、手順として分かりやすい感じかなぁ、と個人的には感じます。
（いいね！という感じでしたら、執筆すすめてみます）

* インデント修正

nmori · 2024-01-13T18:34:49Z

Xなどでも感触を聞こうと拡散しましたが、特にリアクションもないようなので
　ここで合意できれば一旦リリースし、使う中で次なるフィードバックをもらったほうが
　お役に立てそうな気がしています。
追加レビューをよろしくおねがいします。
　（おそらく、e2eのところをもう少し細かく書くべきか、一旦これぐらいにするかが
　　論点にあがるぐらいで、後は以前のレビュー内容でそこまで問題ないだろうと考えてはいます）

Hiroshiba

すみません、大変お待たせしました！！！

後継者ガイドラインの整備ありがとうございます！
是非取り込ませていただきたいと思っています！！

読んでいて、よくある貢献者ガイドラインというよりは、Github上にあるプロジェクトに貢献するための流れみたいな感じだなと思いました！
実際、プログラミングはできるけれどもgithubはよくわからん、という方が今までの個人開発者の人には多かったと思うので、そこの手助けをしてあげる形で良さそうに思いました！

もしかしたら、将来的にここの後継者ガイドラインはVOICEVOXエディタに特化したものに変えさせていただくかもしれません。
その際は「プルリクエストの流れ」として、エディタだけではないVOICEVOX全体のドキュメントとかで紹介させていただく形にさせていただければと･･･！

CONTRIBUTING.md

nmori · 2024-06-02T08:33:46Z

査読ありがとうございます。

たしか最初は貢献者を呼び込むための敷居を下げるニュアンスだったとおもいます。
engine側のガイドラインを読みながら「経験値１つみても幅広い」ことを改めてしったので
ドキュメントがわかれていくのはありかと思います。

（もしかしたら、ある意味ではこのドキュメントを要約したものが貢献者ガイドラインで、
　ここで手厚めに解説している部分は初心者トレーニングガイドとして切り出すのが
　みんなHappyになるルートかもしれないなぁ、とも思いました）

Hiroshiba

ほぼLGTMです！！！

あとはREADMEの## 貢献者の方への辺りに、一言添えつつこちらのCONTRIBUTION.mdへのリンクをお願いします！
入口も入口なのでちょっと丁寧に、かつ端的に、読むことでコミットに進めそうな方へ届く文面だと良さそう！

「興味がある方はウェルカムです、貢献したい際は CONTRIBUTION.md をお読みください。GithubやGitに馴染みがない方向けの詳細な紹介もあります」
みたいな感じ。。。ですかねぇ。。うーん。

CONTRIBUTING.md

・README.mdに誘導リンクを追加

Hiroshiba

LGTM！！！

執筆ありがとうございました！！！
ちょっとこちらで微調整させていただきます！

本当はもっと色んな方が貢献チャレンジしやすくしたいのですが、なにをどう整備するのが良いかわからないんですよね･･･。
もしアイデアとかあればお聞きしたいです！！！

（もしかしたら、ある意味ではこのドキュメントを要約したものが貢献者ガイドラインで、
　ここで手厚めに解説している部分は初心者トレーニングガイドとして切り出すのが
　みんなHappyになるルートかもしれないなぁ、とも思いました）

今のCONTRIBUTING.mdでも十分ですが、初心者ガイド用にうまく切り出せると嬉しそうです。
別リポジトリから参照したり、あと慣れてる人は飛ばして読めたり。

うまい切り出し方法、ありそうですかね･･･？
docs/貢献初心者ガイド.mdを作ってリンクするとか･･････？
（やるにしても別プルリクエストが良さそう）

あともう１点相談が 🙇

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

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

#VOICEVOX開発状況 
VOICEVOXエディタの貢献者ガイドラインができました🎉
プログラム作成、ドキュメント執筆、テスト生成、改善提案への議論参加など様々な参加方法があります。
ガイドラインはこちら↓
https://github.com/VOICEVOX/voicevox/blob/main/CONTRIBUTING.md
【開発者: @mikasa231】
https://github.com/VOICEVOX/voicevox/pull/1202

CONTRIBUTING.md

nmori · 2024-06-16T13:17:10Z

ありがとうございます。査読ありがとうございます。
ポストの件もOKです。

これをリリースすることで、読んだ方からの新たな議論がうまれるとおもうので、
その時に次のリニューアルを別Issueで進められたら嬉しいです。ありがとうございます。

Hiroshiba · 2024-06-16T13:38:07Z

マージします！

nmori added 9 commits February 5, 2023 11:35

未対応エンジン追加時にリストが消える件(VOICEVOX#1168)

0972e5e

・追加されたエンジンが未対応である場合には追加を阻止・追加されてしまっている場合には、エラーで処理中断しないように

lintチェックエラー部分の修正

cb5552c

コードレビューの反映 (ref VOICEVOX#1179)

00b7673

・MinimumEngineManifestの更新

コードレビュー分の反映②　ref VOICEVOX#1179

4b21b85

・engineManifests[selectedId]自体が undefined であるケースに対応

Merge branch 'main' of https://github.com/voicevox/voicevox

ad8c1de

* コンフリクトの修正

6e91471

Merge branch 'main' of https://github.com/voicevox/voicevox

4e8cde0

貢献者ガイドラインを明文化　(ref VOICEVOX#1190)

ca0083a

Merge branch 'VOICEVOX:main' into 貢献者ガイドラインVOICEVOX#1190

3b632e7

nmori requested a review from a team as a code owner February 12, 2023 03:09

nmori requested review from Hiroshiba and removed request for a team February 12, 2023 03:09

sevenc-nanashi reviewed Feb 12, 2023

View reviewed changes

nmori added 3 commits February 12, 2023 13:57

レビュー結果の反映①

205b1c8

Merge branch '貢献者ガイドラインVOICEVOX#1190' of https://github.com/nmori/voi…

e621935

…cevox into 貢献者ガイドラインVOICEVOX#1190

着手周りの手順追記

ead2d1a

nmori added 2 commits February 18, 2023 03:43

CONTRIBUTING.md　として配置変更

5462dd9

markdownlint のエラーを修正

ce4721c

* ローカル実行時の markdownlint 検索範囲を修正

da620ab

Issueを閉じるタイミングを追記

0f73ffd

sevenc-nanashi reviewed Feb 18, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

* ドラフトプルリクエストについての追記

0b6b493

* フォーマットの修正

* プルリクエストの表記を英語に。

c8686fc

* WIPに付いてのトーンを弱めに。 * リンク切れの修正 *　「その他」の追記

sevenc-nanashi reviewed Dec 12, 2023

View reviewed changes

* レビュー内容の反映

26b5b53

* e2e部分の追記

f94b0b5

* インデント修正

Hiroshiba reviewed May 28, 2024

View reviewed changes

Hiroshiba mentioned this pull request May 29, 2024

追加: 貢献者ガイドブラッシュアップ VOICEVOX/voicevox_engine#1215

Merged

提案いただいた分のコミットと追記

bea5660

Hiroshiba reviewed Jun 9, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

・査読分の反映

c382437

・README.mdに誘導リンクを追加

Hiroshiba approved these changes Jun 16, 2024

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

Apply suggestions from code review

3f611bf

Hiroshiba added 6 commits June 16, 2024 22:17

フォーマットを整える

4e24c5a

崩れてしまった部分を戻す

966021a

こう？

5c36e24

なぜか * に戻っていた

54c3715

pythonはコメントアウトが // ではなかった

d4fe9a9

Merge remote-tracking branch 'upstream/main' into pr/nmori/1202-1

c7ffa23

Hiroshiba merged commit 7a2e580 into VOICEVOX:main Jun 16, 2024
8 checks passed

Hiroshiba mentioned this pull request Jun 28, 2024

feat: speaker_infoをURLで受け取るようにする #2095

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

貢献者ガイドラインの作成 #1202

貢献者ガイドラインの作成 #1202

nmori commented Feb 12, 2023

sevenc-nanashi left a comment

Hiroshiba commented Feb 13, 2023 •

edited

Loading

nmori commented Feb 13, 2023

nmori commented Feb 14, 2023

Hiroshiba commented Feb 14, 2023

y-chan commented Feb 17, 2023

nmori commented Feb 17, 2023 •

edited

Loading

nmori commented Feb 18, 2023

sevenc-nanashi commented Feb 18, 2023

Hiroshiba commented Dec 5, 2023

nmori commented Dec 10, 2023

Hiroshiba commented Dec 12, 2023

sevenc-nanashi left a comment

sabonerune commented Dec 13, 2023

nmori commented Dec 17, 2023

sabonerune commented Dec 18, 2023

nmori commented Dec 18, 2023 •

edited

Loading

nmori commented Jan 13, 2024

Hiroshiba left a comment •

edited

Loading

nmori commented Jun 2, 2024

Hiroshiba left a comment •

edited

Loading

Hiroshiba left a comment

nmori commented Jun 16, 2024

Hiroshiba commented Jun 16, 2024

貢献者ガイドラインの作成 #1202

貢献者ガイドラインの作成 #1202

Conversation

nmori commented Feb 12, 2023

内容

関連 Issue

スクリーンショット・動画など

その他

sevenc-nanashi left a comment

Choose a reason for hiding this comment

Hiroshiba commented Feb 13, 2023 • edited Loading

nmori commented Feb 13, 2023

nmori commented Feb 14, 2023

Hiroshiba commented Feb 14, 2023

y-chan commented Feb 17, 2023

nmori commented Feb 17, 2023 • edited Loading

nmori commented Feb 18, 2023

sevenc-nanashi commented Feb 18, 2023

Hiroshiba commented Dec 5, 2023

nmori commented Dec 10, 2023

Hiroshiba commented Dec 12, 2023

sevenc-nanashi left a comment

Choose a reason for hiding this comment

sabonerune commented Dec 13, 2023

nmori commented Dec 17, 2023

sabonerune commented Dec 18, 2023

nmori commented Dec 18, 2023 • edited Loading

nmori commented Jan 13, 2024

Hiroshiba left a comment • edited Loading

Choose a reason for hiding this comment

nmori commented Jun 2, 2024

Hiroshiba left a comment • edited Loading

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

nmori commented Jun 16, 2024

Hiroshiba commented Jun 16, 2024

Hiroshiba commented Feb 13, 2023 •

edited

Loading

nmori commented Feb 17, 2023 •

edited

Loading

nmori commented Dec 18, 2023 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

Hiroshiba left a comment •

edited

Loading