This guide was written for Japanese-speaking contributors. If you are an English speaker and would like to contribute, please post on GitHub Discussion in SuteraVR.
このガイドは日本語話者のコントリビューターの為に書かれました。もしもあなたが英語話者でコントリビュートしたい場合はGitHub Discussion in SuteraVRに投稿してください。
現在コントリビューティングガイドが作成しきれていない為、記述が及ばない点があるかもしれません。ご了承ください。コントリビューティングガイドについて改善点を考えついた場合はGitHub Discussion in SuteraVRに投稿してください。
開発フローは以下の様にしてください。
- イシューを立てる
- プルリクエストをイシューに関連付けて作成する
- レビューを誰かから受ける
- Approveを貰ったらマージする
- イシューは、Conventional Commits:v1.0.0のタイトルと同じように名前を付けてください。
- イシューを立てる前には必ず同様のイシューが存在しない事を確認してください。もしもイシューの内容が被っていた場合には
Not Plannedとしてイシューを閉じてください。
{イシューの型}/{実装内容を簡潔に、かつハイフンで区切って記す}のように作成してください。以下に例を記載します。
fix/rewrite-contributing-md
feat/add-clocking-server
docs/write-some-docs- マイルストーンはバージョン毎に管理します。
- バージョン規則はセマンティック バージョニング:v2.0.0に従います。
- マイルストーンはサーバーとクライアントでは分けずに管理します。
- プルリクエストは必ずイシューに関連づけて作成してください。関連づける方法はGitHub Docsを参照してください。以下にコメントの例を記載します。
- close #35
Fix typo in `CONTRIBUTING.md`.- 現在パブリックベータであるIssueのためのブランチの作成機能は、コメントに
- close #35のような記法を使用した場合にログが二個出現してしまうために使用しないでください。
- 現在存在するCIは、
cargo testとcargo fmt、cargo clippyをそれぞれのRustクレートに対して走らせるもののみです。もしも他にCIを走らせるべきだと感じたならば、その点を纏めてイシューを作成してください。
現在SuteraVRはGitHub Projectを活用しています。SuteraVR's Project 以下に注意事項を記載します。
- プルリクエストはイシューの欄にデフォルトで記載されているため、含める必要はありません。プルリクエストはProjectに登録しないでください。特に@haruki7049は気を付けてください。