ドキュメント貢献する

貢献する

受け入れるパッチ。拒否するパッチ。

オープンなコントリビュータープロセス — 規律については少々こだわりますが、あなたが誰かについては決してこだわりません。

01

取り組むものを選ぶ

リポジトリは初手のイシューを good-first-issue とラベル付けします。メンテナーがこれらをトリアージし、スコープが妥当でステップが明確かを確認します。ひとつ完了したら、ラベルは付けたままにしてください — 次の人の助けになります。

より大きな作業については、まずディスカッションを開いてください。私たちは はい、いいえ、あるいは まだです、理由はこうです と答えます。「いいえ」と言うことは、あなたの時間を尊重することの一部です。

02

コミットに署名する

shell# in your local clone
git config user.signingkey YOUR_KEY_FINGERPRINT
git config commit.gpgsign true
git config tag.gpgsign true

GPG 署名済みのコミットを求めます。これは門前払いのためではなく — プロジェクトのサプライチェーンを正直に保つためです。まだ鍵がなければ、リポジトリの wiki が生成手順を案内します。

サインオフ行
すべてのコミットメッセージは、Developer Certificate of Origin のサインオフ(Signed-off-by: Name <email>)で終わる必要があります。 git commit -s を使えば自動で付加できます。
03

コンベンショナルなコミットメッセージを書く

commit messagefeat(lsia): emit telemetry on safe-mode entry

Adds a single counter when the immune-system engine enters safe mode.
The counter is hashed-pattern only and respects the privacy gate.

Refs: #842
Signed-off-by: A. Researcher <a@example.org>

1行目には Conventional Commits 仕様に従います。本文は「なぜ」を説明します。フッターはイシューや関連変更を参照します。

04

プルリクエストを開く

プルリクエストは3つの自動ゲートと人間のレビューを通ります:

  • 再現可能ビルドのチェックが、あなたのパッチが決定性を壊さないことを検証します。
  • プライバシーゲートが、生データの経路が導入されていないことを検証します。
  • ユニットテストと統合テストのスイートが合格しなければなりません。
  • マージ前に2名のレビュアーが承認します。セキュリティに敏感な領域はセキュリティレビュアーを必要とします。
プライバシーゲートが失敗したら
止まってください。差分を慎重に読み直してください — このテストは、あるコード経路が生の識別子(IP、メール、IMEI、GPS)を漏らし得るときに失敗します。修正は、ほぼ決してテストを無効化することではありません。
05

評価

受け入れられたすべての貢献は、次のリリースノートに掲載されます — 匿名を希望しない限り、クレジット付きで。AUTHORS ファイルは、あなたが初めて変更をマージしたときに自動更新されます。

より大きな作業 — 主要機能、監査、翻訳 — については、変更履歴のエントリがあなたを名前で挙げます。匿名のクレジットは特別な依頼ではなく、普通の依頼です。

06

行動規範

私たちは Contributor Covenant 2.1 に従います。個人攻撃、脅迫、ドキシング、ハラスメントは即時排除の違反であり、苦情の連鎖は不要です。全文はリポジトリの CODE_OF_CONDUCT.md にあります。