Contribute to StarRocks
StarRocks への貢献は、誰からでも心より歓迎します。StarRocks への貢献は、コードの貢献に限りません。以下に、コミュニティへの貢献方法をいくつか挙げます。
バグを報告する | StarRocks に関するバグを報告するには、issue を提出できます。また、ドキュメントサイトのページ右上にある Feedback をクリックしてバグを報告することもできます。 |
---|---|
コードを貢献する | バグを修正したり、機能を実装することでコードを貢献できます。 |
テストケースを貢献する | テストケースを貢献できます。 |
コードレビューを手伝う | StarRocks のアクティブな貢献者またはコミッターであれば、プルリクエスト (PR) のレビューを手伝うことができます。 |
ドキュメントを貢献する | StarRocks コミュニティは、中国語と英語の膨大な量のドキュメントを維持しています。ドキュメントのバグを修正したり、新しいコンテンツを提案することでドキュメントを貢献できます。 |
StarRocks ユーザーを助ける | コミュニティで困難に直面している新参者を助けることができます。 |
StarRocks を広める | 私たちの技術を世界に広めるために、記事を書いたり講演を行ったりすることができます。 |
NOTE
ドキュメントを貢献する際は、
git commit -s
を使用してコミットに 署名 することを忘れないでください。そうしないと、Developer Certificate of Origin (DCO) チェックが失敗し、PR がブロックされる可能性があります。さらに、PR タイトルに[Doc]
をプレフィックスとして付け、Doc チェックボックスを選択してください。
コミュニティリソース
StarRocks に関する幅広いサポートを得るための最良の場所は、StarRocks の Slack チャンネル です。貢献に関する議論については、#contributing-to-starrocks チャンネルに参加してください。
また、GitHub で問題や課題を報告したり、新機能を提案したりすることもできます。
行動規範
私たちのコミュニティは、行動規範 を厳守しています。
コミュニティの役割
誰もが StarRocks プロジェクトに参加することを奨励しています。新機能、プロジェクトのロードマップ、アーキテクチャについての議論に参加したり、直面している問題を報告するだけで、誰でも影響を与えることができます。
以下に示す役割は、コミュニティに参加するためのいくつかの方法であり、各役割に期待されることを定義しています。
ユーザーグループ
参加者
参加者はコミュニティに積極的に関与し、StarRocks をより良くするために取り組んでいます。
参加者として、GitHub での問題報告、テストケースの貢献、ドキュメントの翻訳/修正、フォーラムやコミュニティでのユーザー質問への回答、イベントへの参加、StarRocks の経験を共有、GitHub での StarRocks のスター付けなどができます。
期待されることと責任:
-
コミュニティの行動規範に従う。
-
議論やコミュニティイベントに参加する。
-
コミュニティにフィードバックを共有し、何が機能しているか/していないかを他の人に知らせる。
-
改善を提案する。
チャンピオン
StarRocks コミュニティチャンピオンは、StarRocks 技術に精通した情熱的なコミュニティの伝道者と先駆者のグループです。彼らはコミュニティで最新の開発や製品を共有することを楽しみ、その情熱がコミュニティの進歩と発展を促進します。
利点
製品
-
新しい製品/機能への早期アクセス。
-
プロジェクトのコアチームとの独占的な会議に参加。
コミュニティ
-
ウェブサイトに StarRocks チャンピオンとして掲載。
-
独占的な賞品とバッジ。
イベント
-
StarRocks のイベントへの無料アクセス。
-
イベントのための旅行および宿泊費の払い戻し。
-
VIP 席と VIP イベント。
要件
- StarRocks に関連するオリジナルで質の高い技術コンテンツ(記事、チュートリアル、ビデオなど)を少なくとも 3 つ公開していること。
- スピーカーとして少なくとも 2 回のオンライン/オフラインの技術共有セッションに参加していること。
- Slack やその他のチャンネルでユーザーの質問に答えることを手伝うこと。
その他の要件
- StarRocks チャンピオンは、StarRocks コミュニティの行動規範を遵守しなければなりません。
- StarRocks チャンピオンの資格は 1 年間であり、過去 1 年間の貢献に基づいて毎年再申請する必要があります。
開発者グループ
コントリビューター
貢献するすべての人が StarRocks のコントリビューターになることができます。メンバーは、新しいコントリビューターが支援を必要とする際に指導とガイダンスを提供します。
コントリビューターになるには?
- StarRocks の公開リポジトリで 1 つのマージされた PR。
コントリビューターとして、私たちはあなたに以下を期待します
-
StarRocks プロジェクトの開発に積極的に参加する。
-
コミュニティイベント(ミートアップ、ハッカソンなど)に参加する。
-
StarRocks 関連の技術を学び、他の人が学ぶのを助ける。
特典
-
StarRocks コントリビューターとしてリストされる。
-
StarRocks コントリビューターの e-証明書を授与される。
アクティブコントリビューター
アクティブコントリビューターは、StarRocks に対して卓越した貢献と持続的なコミットメントを示したコントリビューターです。彼らはコードの貢献、ドキュメントの改善、他者の支援を通じてコミュニティに積極的に参加しています。
アクティブコントリビューターになるには?
-
5 つのマージされた PR または主要なバグを修正。
-
5 回以上のコードレビューに参加。
-
オンライン/オフラインのミートアップやコミュニティディスカッションなどのコミュニティイベントに積極的に参加。
責任と特典
-
コミュニティミーティングとディスカッションに参加。
-
新しいコントリビューターを指導し、ガイドする。
-
StarRocks アクティブコントリビューターとしてリストされる。
-
StarRocks アクティブコントリビューターの e-証明書を授与される。
コミッター
コミッターはアクティブコントリビューターから昇格されます。
彼らはマスターブランチに PR をマージする権限を持ち、StarRocks の計画とメンテナンスに責任を持っています。また、コミュニティで知識を共有するアクティブなメンバーでもあります。
コミッターになるには?
-
StarRocks の原則と将来の計画を深く理解していること。
-
プロジェクトで発生するさまざまな問題に迅速に対処する能力を持っていること。
-
主要な開発をリードし、関連するドキュメントを作成および修正する。
-
少なくとも 2 つの PMC の指名を受け、投票を通過する。
責任と特典
-
コミュニティ内の他のメンバーシップを指導し、ガイドする。
-
サブプロジェクトの継続的な健康を確保する。
-
StarRocks リポジトリへの書き込みアクセスを許可される(指定される)。
-
StarRocks コミッターとしてリストされる。
-
StarRocks コミッターの e-証明書を授与される。
PMC
PMC はコミッターから昇格されます。彼らはマスターブランチに PR をマージする権限を持ち、StarRocks の計画とメンテナンスに責任を持っています。また、コミュニティで知識を共有するアクティブなメンバーでもあります。
PMC になるには?
-
StarRocks の原則を深く理解し、StarRocks の将来の計画を明確に理解していること。
-
プロジェクトの問題に迅速に対処する能力を持っていること。
-
プロジェクトの開発とイテレーションをリードし、プロジェクトの全体的な方向性を導く。
-
少なくとも 2 つの PMC の指名を受け、投票を通過する。
責任と特典
-
コミュニティ内の他のメンバーシップを指導し、ガイドする。
-
プロジェクトの継続的な健康を確保する(コード品質やテストカバレッジなど)。
-
技術設計の決定を行い、承認する。
-
マイルストーンとリリースを定義する。
-
新しいコミッターと PMC を投票で昇格させる。
-
StarRocks PMC としてリストされる。
-
StarRocks PMC の e-証明書を授与される。
貢献プロセス
どこから始めればいいかわからない場合は、以下のプロセスをお勧めします。このプロセスは、学習曲線を減らし、プルリクエストをより効率的にマージするのに役立つように設計されています!
-
GitHub で issue を作成するか、Slack チャンネル で質問して、ディスカッションを開始します(変更が些細でない限り)。
コードに手を付ける前に、issue 本文にコメントし、解決したい issue をメンテナーに割り当てるように通知してください。また、この問題を解決する方法についての計画を issue 本文で共有することをお勧めします。
- このステップは、可能な協力者とレビュアーを特定するのに役立ちます。
- 変更が進行中の他の変更と競合するかどうかを確認します。もしそうなら、影響を最小限に抑えるために他の人と協力してください。
- 変更が大きい場合は、他の人と協力して変更を小さなステップに分割してください。
-
変更を実装します。
-
変更が大きい場合は、小さな PR に分割してください。
-
必要に応じてテストとドキュメントを含めてください。
-
-
GitHub で pull request を作成します:
StarRocks コミュニティでは、コードを貢献する際にフォーク・アンド・マージの GitHub ワークフローに従います。
- GitHub アカウントで StarRocks をフォークします。
- このフォークされたリポジトリをコンピュータにクローンします。
- 貢献したいブランチに基づいて新しいブランチをチェックアウトします。
- 新しいブランチにコード変更をコミットします。
- コード変更を含むブランチを GitHub にプッシュします。
- コード変更を提出するために PR を作成します。1 つの PR に 1 つのコミットを提出することをお勧めします。PR を提出する際は、PR テンプレート に従うことができます。
- プルリクエストが CI のテストに合格することを確認してください。
-
少なくとも 2 人のレビュアーによるレビューが必要です:
-
StarRocks プロジェクトでは、プルリクエストをマージするために少なくとも 2 人のレビュアー(コミッター)からの lgtm が必要です。
-
通常、これは数日以内に行われますが、変更が大きい、複雑である、または重要なレビュアーが利用できない場合は、時間がかかることがあります。(プルリクエストでレビュアーに ping しても構いません)。
-
-
メンテナーが最終的な変更を受け入れた後にプルリクエストをマージします。