コードのコミット¶

プルリクエストの取り扱い¶

Django は GitHub でホストされているので、パッチはプルリクエストの形で提供されます。

プルリクエストをコミットする際には、個々のコミットが以下に説明するコミットガイドラインに合致していることを確認してください。コントリビューターは可能な限り最高のプルリクエストを提供することが期待されています。実際には、コミットガイドラインに精通しているであろうマージャーが、自分自身でコミットを標準に近づけることを決定するかもしれません。

JenkinsやGitHubのアクションに、OracleやSeleniumのような自動で実行されないプルリクエストビルダーを使ってプルリクエストをテストさせたいかもしれません。手順については CI wiki page を参照してください。

ローカルでプルリクエストをチェックすることが多くなったら、この git エイリアスが役立つでしょう:

[alias]
    pr = !sh -c \"git fetch upstream pull/${1}/head:pr/${1} && git checkout pr/${1}\"

これを ~/.gitconfig に追加し、 upstream を django/django に設定してください。そして、 git pr #### を実行すると、対応するプルリクエストをチェックアウトできます。

この時点で、コードに手を加えることができます。 git rebase -i と git commit --amend を使って、コミットの品質が期待通りのものであることを確認しましょう。準備ができたら次のようにします:

$ # Pull in the latest changes from main.
$ git checkout main
$ git pull upstream main
$ # Rebase the pull request on main.
$ git checkout pr/####
$ git rebase main
$ git checkout main
$ # Merge the work as "fast-forward" to main to avoid a merge commit.
$ # (in practice, you can omit "--ff-only" since you just rebased)
$ git merge --ff-only pr/XXXX
$ # If you're not sure if you did things correctly, check that only the
$ # changes you expect will be pushed to upstream.
$ git push --dry-run upstream main
$ # Push!
$ git push upstream main
$ # Delete the pull request branch.
$ git branch -d pr/xxxx

...\> REM Pull in the latest changes from main.
...\> git checkout main
...\> git pull upstream main
...\> REM Rebase the pull request on main.
...\> git checkout pr/####
...\> git rebase main
...\> git checkout main
...\> REM Merge the work as "fast-forward" to main to avoid a merge commit.
...\> REM (in practice, you can omit "--ff-only" since you just rebased)
...\> git merge --ff-only pr/XXXX
...\> REM If you're not sure if you did things correctly, check that only the
...\> REM changes you expect will be pushed to upstream.
...\> git push --dry-run upstream main
...\> REM Push!
...\> git push upstream main
...\> REM Delete the pull request branch.
...\> git branch -d pr/xxxx

ブランチを強制的にプッシュします。これにより、メインとブランチのコミットハッシュが一致するようになり、プルリクエストが自動的にクローズされます。

プルリクエストを複数のコミットとしてマージする必要がない場合は、GitHub の "Squash and merge" ボタンを使ってください。コミットメッセージを ガイドライン に合うように必要に応じて編集し、メッセージの最初の行に自動的に付加されるプルリクエスト番号を削除します。

プルリクエストのコミット履歴を書き換えるとき、その目的は Django のコミット履歴をできるだけ有用なものにすることです:

• パッチに前後のコミットが含まれている場合は、それらをひとつに書き換えてください。たとえば、あるコミットでコードが追加され、2番目のコミットで最初のコミットで発生した文体上の問題が修正された場合、マージする前にそれらのコミットをひとつにまとめる必要があります。

• 異なるコミットへの変更を論理的なグループ分けで分ける: ファイルへの他の変更と同時にスタイルのクリーンアップを行う場合、変更を 2 つの異なるコミットに分けることで、履歴のレビューがしやすくなります。

• プルリクエスト内の上流ブランチのマージに注意してください。

• コミットするたびに、テストをパスし、ドキュメントをビルドしなければなりません。テストもドキュメントも警告を出すべきではありません。

• 些細なパッチや小さなパッチは通常1つのコミットで行うのがベストです。中規模から大規模の作業については、理にかなっていれば複数のコミットに分けても構いません。

実用性は純粋さに勝るので、プルリクエストに対してどの程度履歴を加工するかは各マージャー次第です。主なポイントは、コミュニティを巻き込むこと、仕事を終わらせること、そして使えるコミット履歴を持つことです。

コミットガイドライン¶

また、Django の Git リポジトリにコードをコミットする際には、以下のガイドラインに従ってください:

• 強制プッシュによって django/django ブランチの公開履歴を変更してはいけません。どうしても必要な場合 (例えばセキュリティ上の理由) は、まずチームと話し合ってください。

• For any medium-to-big changes, where "medium-to-big" is according to your judgment, please bring things up on the Django Forum before making the change.

  If you bring something up and nobody responds, please don't take that to mean your idea is great and should be implemented immediately because nobody contested it. Everyone doesn't always have a lot of time to read discussions immediately, so you may have to wait a couple of days before getting a response.

• コミットメッセージは、現在形ではなく過去形で詳細を書いてください。

  • 良い例: "Fixed Unicode bug in RSS API."

  • 悪い例: "Fixes Unicode bug in RSS API."

  • 悪い例: "Fixing Unicode bug in RSS API."

  コミットメッセージは、最大72文字の行で記述するべきです。件名の行があり、空行で区切った後に72文字の行で段落を構成します。これらの制限は厳格ではありません。件名に関しては、短い方が良いです。コミットメッセージの本文では、詳細な情報が少ない情報よりも好ましいです:

  Fixed #18307 -- Added git workflow guidelines.
  
  Refactored the Django's documentation to remove mentions of SVN
  specific tasks. Added guidelines of how to use Git, GitHub, and
  how to use pull request together with Trac instead.
  

  "Thanks A for the report and B for review." のように、コミットメッセージでコントリビューターをクレジットしてください。git の Co-Authored-By を適切に使用してください。

• ブランチへのコミットの場合は、コミットメッセージの前にブランチ名をつけます。たとえば "[1.4.x] Fixed #xxxxx -- Added support for mind reading." のようにします。

• コミットは、意味のある最も細かい変更に限定しましょう。つまり、大きなコミットをたまに行うのではなく、小さなコミットをまめに行うようにしましょう。たとえば、機能Xの実装にライブラリYへの小さな変更が必要な場合、まずライブラリYへの変更をコミットし、その後、別のコミットで機能Xをコミットします。これは、皆があなたの変更に追いつくのに*大いに役立ちます*。

• 機能変更からバグ修正を分けてください。バグ修正は サポートバージョン に基づいて安定ブランチにバックポートする必要があることがあるためです。

• あなたのコミットが Django ticket tracker のチケットをクローズする場合、コミットメッ セージを "Fixed #xxxxx" というテキストで始めます。例: "Fixed #123 -- Added whizbang feature."。 Trac では、この形式のコミットメッセージは自動的に参照されたチケットをクローズし、完全なコミットメッセージとともにコメントを投稿するように設定しています。

  好奇心旺盛な方のために、私たちはこのために Trac plugin を使っています。

• あなたのコミットが Django ticket tracker のチケットを参照しているものの、そのチケットを クローズ はしていない場合、"Refs #xxxxx "というフレーズを含めてください。"xxxxx "はあなたのコミットが参照しているチケットの番号です。これで自動的に適切なチケットにコメントが投稿されます。

• このパターンを使ってバックポートのコミットメッセージを書いてください:

  [<Django version>] Fixed <ticket> -- <description>
  
  Backport of <revision> from <branch>.
  

  例えば:

  [1.3.x] Fixed #17028 -- Changed diveintopython.org -> diveintopython.net.
  
  Backport of 80c0cbf1c97047daed2c5b41b296bbc56fe1d7e3 from main.
  

  ` これを自動化するスクリプト <https://code.djangoproject.com/wiki/MergerTips#AutomatingBackports>`_ が wiki にあります。

  コミットによってリグレッションが修正された場合は、その旨をコミットメッセージに含めてください:

  Regression in 6ecccad711b52f9273b1acb07a57d3f806e93928.
  

  (リグレッションが取り込まれたコミットハッシュを使用します)。

コミットの取り消し¶

完璧な人はいません。間違ったコミットがなされることもあります。

しかし、ミスが起こらないように最大限の努力をしましょう。私たちに差し戻しポリシーがあるからといって、可能な限り最高の品質を目指すあなたの責任が緩和されるわけではありません。本当に: 自分の仕事をダブルチェックするか、そもそもコミットする**前に**別のマージャーにチェックしてもらいましょう！

誤ったコミットが発見された場合は、以下のガイドラインに従ってください:

• 可能であれば、元の作者に自分のコミットを差し戻してもらいましょう。

• 原作者の許可なく、他の作者の変更を元に戻さないでください。

• git revert を使用します。これは逆コミットを行いますが、元のコミットはコミット履歴に残ります。

• If the original author can't be reached (within a reasonable amount of time -- a day or so) and the problem is severe -- crashing bug, major test failures, etc. -- then ask for objections on the Django Forum then revert if there are none.

• 問題が小さい場合（例えば、機能フリーズ後の機能コミット）は、そのまま待ちましょう。

• If there's a disagreement between the merger and the reverter-to-be then try to work it out on the Django Forum . If an agreement can't be reached then it should be put to a vote.

• もしそのコミットが、確認され、公開されたセキュリティ脆弱性を含んでいた場合、そのコミットは誰の許可も得ずに即座に差し戻されるかもしれません。

• リリースブランチのメンテナは、そのコミットがリリースブランチを壊してしまった場合、許可なくリリースブランチへのコミットを取り消すことができます。

• 誤ってトピックブランチを django/django にプッシュした場合は、削除してください。例えば、 git push upstream feature_antigravity を実行した場合は、逆のプッシュを行ってください: git push upstream :feature_antigravity 。