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.

Sign up for GitHub

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

Jump to bottom

貢献者ガイドラインに記載する事項 #1190

Closed
3 tasks
nmori opened this issue Feb 8, 2023 · 6 comments
Closed
3 tasks

貢献者ガイドラインに記載する事項 #1190

nmori opened this issue Feb 8, 2023 · 6 comments
Labels
要議論 実行する前に議論が必要そうなもの

Comments

@nmori
Copy link
Contributor

nmori commented Feb 8, 2023

質問の内容

ref #1168 内で会話になった「貢献者ガイドライン」について。
今回体感したことをベースに、いったん書いてPR出そうと考えています。

記載するにあたり、

  • 現時点でドキュメントに明記されていないルールがあれば教えてください
  • 把握することがベストであろうコミュニティ上の文化、風習を教えてください
  • これから参加する貢献者・開発者が押さえておくべき事項があれば教えてください
  • PRするにあたり、「これが守られていれば査読者の負担が減る」事項があれば教えてください
  • 遵守事項（Must）、推奨事項(Better) があれば教えてください

こちらで教えて頂いた内容もふまえて、ドキュメントにおこしてみます。

VOICEVOXのバージョン

OSの種類/ディストリ/バージョン

  • Windows
  • macOS
  • Linux

その他
@Hiroshiba
Copy link
Member

Hiroshiba commented Feb 8, 2023 •
edited
Loading

issue作成ありがとうございます！！

現時点でドキュメントに明記されていないルールがあれば教えてください

いまのところ無いかもです！
あ、ルールじゃないですが、マージされるとVOICEVOXソフトウェアの更新履歴にコミッターのGithub IDが刻まれます。

把握することがベストであろうコミュニティ上の文化、風習を教えてください

定まってないですが、「相手にリスペクトを持ってコメントする」とかでしょうか･･･。
あとはよくある「差別しない」とか･･･？
discordがあることを伝えても良いかもとちょっと思いました！

これから参加する貢献者・開発者が押さえておくべき事項があれば教えてください

こちらも特に思いつきませんでした。
/docsにある他のドキュメントは参考になると思います、くらいかなと！

PRするにあたり、「これが守られていれば査読者の負担が減る」事項があれば教えてください

PR作った後に自分のPRの差分を見直してもらえると、負担が減るしPR作った本人も自分で成長できて良いかなと！
あとは、UIや仕様変更の際は先にissueを作って聞いてもらえると、手戻りが少なくなったりするかもです！

遵守事項（Must）、推奨事項(Better) があれば教えてください

こちらも今のところは用意してません。
（本当は行動規範なども定めたほうが良いのですが、手が回ってない感じです 😇 ）

@nmori
Copy link
Contributor Author

nmori commented Feb 8, 2023

ありがとうございます。

上記の質問については、ほかにコード提供されている方や
反映作業に従事されている方からも情報を伺いたいので、
お気づきの点ありましたらよろしくお願い致します。

@y-chan y-chan added the 要議論 実行する前に議論が必要そうなもの label Feb 11, 2023
nmori added a commit to nmori/voicevox that referenced this issue Feb 11, 2023
@nmori
貢献者ガイドラインを明文化　(ref VOICEVOX#1190)
ca0083a
@nmori
Copy link
Contributor Author

nmori commented Feb 11, 2023

・思いつくまま、いったん文章にしました。
・そもそもこの形での記述がよいか、他に必要な部分、不要な部分、誤解などあれば教えてください
・もうちょっと議論で形ができれば、PRを出します。
・PRする段階では、トップページと情報が被っている部分も整理したほうが良いかと考えています。

@sevenc-nanashi
Copy link
Member

sevenc-nanashi commented Feb 11, 2023 •
edited
Loading

個人の意見：PRで議論する方がレビューも書けるのでPRで議論してもいいと思います。

@Hiroshiba
Copy link
Member

@nmori すごく丁寧でとても良いと思いました！！！！！
ぜひPR化していただければ！！

あ、書くにあたって参考にした資料などあれば知りたいかもです🙏

続きはPR側で議論しても良いかもですね！

@nmori
Copy link
Contributor Author

nmori commented Feb 12, 2023

お二方、ありがとうございます。
ファイルベースの議論に立ってよい、という感触なのでPRだしますね。

このあたりを参考にしましたが、
今回ワンサイクル回すにあたって足りなかったので、いろいろ追記しました。

nmori added a commit to nmori/voicevox that referenced this issue Feb 12, 2023
@nmori
Merge branch 'VOICEVOX:main' into 貢献者ガイドラインVOICEVOX#1190
3b632e7
@nmori nmori mentioned this issue Feb 12, 2023
Merged
nmori added a commit to nmori/voicevox that referenced this issue Feb 12, 2023
@nmori
Merge branch '貢献者ガイドラインVOICEVOX#1190' of https://github.com/nmori/voi…
e621935 
…cevox into 貢献者ガイドラインVOICEVOX#1190
Hiroshiba added a commit that referenced this issue Jun 16, 2024
@nmori @Hiroshiba
貢献者ガイドラインの作成 (#1202)
7a2e580 
* 未対応エンジン追加時にリストが消える件(#1168)
・追加されたエンジンが未対応である場合には追加を阻止
・追加されてしまっている場合には、エラーで処理中断しないように

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

* コードレビューの反映 (ref #1179)
・MinimumEngineManifestの更新

* コードレビュー分の反映②　ref #1179
・engineManifests[selectedId]自体が undefined であるケースに対応

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

* レビュー結果の反映①

* 着手周りの手順追記

* CONTRIBUTING.md　として配置変更

* markdownlint のエラーを修正

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

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

* * ドラフトプルリクエストについての追記
* フォーマットの修正

* * プルリクエストの表記を英語に。
* WIPに付いてのトーンを弱めに。
* リンク切れの修正
*　「その他」の 追記

* * レビュー内容の反映

* * e2e部分の追記
* インデント修正

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

* ・査読分の反映
・README.mdに誘導リンクを追加

* Apply suggestions from code review

* フォーマットを整える

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

* こう？

* なぜか * に戻っていた

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

---------

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>
@nmori nmori closed this as completed Jun 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
要議論 実行する前に議論が必要そうなもの
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Hiroshiba @nmori @y-chan @sevenc-nanashi