(CJP) Hacktoberfest です。オープン ソースに貢献して T シャツを獲得するチャンスです。 私自身がオープンソースのメンテナーであるため、これは素晴らしいイニシアチブだと思いますが、責任も伴います。 多くの人が賢くなろうとして、手間がかからず、ボーダーライン スパムの PR を送信し、メンテナーの 1 日を本質的に台無しにしています。
メンテナーを助けるために と 質の高いオープン ソースの作成に貢献してくださっている皆様に、いくつかのヒントをご紹介します。
# 既存の問題と PR を調べることから始めます
ほとんどの PR は善意のものですが、まず既存の問題や同じ問題に対処する PR についてリポジトリを調べることが重要です。 他の誰かがすでに同様の PR に取り組んでいるか、PR の作成を妨げる問題がある可能性があります。 手伝いたい場合は、自分で作業するのではなく、すでに行われている議論に参加することから始めてください。
# 最初に話し合う
機能について何も言われていない場合は、先に進んで数百行のコードを変更する可能性があるのではなく、最初にそれについて話し合うことをお勧めします。 PRは当面の間、私が担当させていただきますので、まずはご相談ください！ コード ベースに関するいくつかのヒントと、実装に関する私たちの期待についてお話しできると思います。
最初にイシューを開くか、最小限の実装でコンセプトの証明となる PR のドラフトを送信するかを選択できます。 私は実際のところ、これらの PR のドラフトがとても気に入っています。変更したいことを視覚化するだけでなく、やるべきことがまだあることに気付いていることも示しています。
tpyoに気づきましたか？ PR を送信して修正することができます。 このブログの最新情報を知りたい場合は、私をフォローしてください。 ツイッター または私のニュースレターを購読してください：
# スタイルガイドに従う
期待について言えば、コミットしようとしているリポジトリにコード スタイル ガイドまたはリンターが設定されているかどうかを確認してください。 それらのルールに従ってください. 意図的に他のスタイリング ルールを使用する PR を送信しないでください。 コードを別のコードベースに送信していて、そのスタイル ガイドに従う必要があります。
メンテナーへのメモ: GitHub アクションを使用して、PR でリンターを自動的に実行することで、ここで支援できます。
# PR を文書化する
私はあなたのコードをレビューするつもりなので、できるだけ明確にしたいと思います。 これは、きれいなコードを書くことから始まります。適切な変数名を使用して、あちこちに doc ブロックを追加することもできます。 しかし、自分の思考過程を説明することも同様に重要です。 レビュー コメントを使用してコードの特定の部分を明確にすることも、PR に一般的なコメントを追加することもできます。
# きれいなコミット
回避してみてください “wip” メッセージをコミットしてください。 コミットごとに本を書く必要はありません。ゾーンにいる間はそれらについて考えたくないかもしれません。 しかし、何かのような “Refactor XX to YY” すでに無限に優れています “wip”. 本当に良いコミット メッセージが必要な場合は、コミットが 1 つのことだけを行うようにし、説明するようにしてください。 どうして このコミットが必要です。
# 関連する変更のみ
PR の範囲内で関連する変更のみを送信します。 作業中にもう 1 つか 2 つ修正したくなるかもしれませんが、それは許されていますが、それらの変更は別の PR に保管してください。
必要に応じて、いつでも PR ブランチに基づいて新しいブランチを作成し、2 番目の PR で、最初にマージされるものに依存することを言及できます。 正しい順序でそれらをマージさせていただきます。
＃ 我慢して
メンテナーが PR をマージするには、しばらく時間がかかる場合があります。 過去数年間、いくつかの PR を見失ったことさえあります。 数日後のフレンドリーな「バンプ」はいつでも歓迎されますが、それでも時間がかかる場合があります。 ほとんどの OSS メンテナは自発的にこれを行っていることを忘れないでください。したがって、PR のマージに少し時間がかかっても気にしないでください。
# フレンドリーに
これは、メンテナと貢献者の両方に当てはまります。馬鹿にしないでください。 PR が却下されることもあれば、メンテナーが忍耐力を失うこともあります。 息を止めて、世界の終わりではないことを認識し、先に進みましょう。 フレンドリーで敬意を表します。
# タグを付けるのに時間がかかりすぎない
これはメンテナー向けです: 最も苛立たしいことの 1 つは、PR が承認され、リリースがタグ付けされるまでさらに 1 か月待たなければならないことです。 高いバージョン番号を恐れる必要はありません。それが semver の目的です。 できるだけ早くリリースにタグを付けてください。もう 1 週間待たないでください!
他にヒントはありますか？ 経由で彼らに知らせる ツイッター または電子メール。 これは、同僚のセバスチャンによる、優れた問題の書き方に関する別の優れた読み物です。