This section is addressed to the mergers and to anyone interested in knowing\nhow code gets committed into Django. The Panduan perbaikan apply\nto all contributors, with or without commit rights.
\nIf you're a community member who wants to contribute code to Django, look at\nBekerja dengan Git dan GitHub instead.
\nSejak Django disimpan pada GitHub, tambalan disediakan dalam formulir dari pull request.
\nWhen committing a pull request, make sure each individual commit matches the\ncommit guidelines described below. Contributors are expected to provide the\nbest pull requests possible. In practice mergers - who will likely be more\nfamiliar with the commit guidelines - may decide to bring a commit up to\nstandard themselves.
\nYou may want to have Jenkins or GitHub actions test the pull request with one\nof the pull request builders that doesn't run automatically, such as Oracle or\nSelenium. See the CI wiki page for instructions.
\nIf you find yourself checking out pull requests locally more often, this git\nalias will be helpful:
\n[alias]\n pr = !sh -c \\"git fetch upstream pull/${1}/head:pr/${1} && git checkout pr/${1}\\"\nTambahkan ke ~/.gitconfig anda, dan setel upstream menjadi django/django. Kemudian anda dapat menjalankan git pr #### untuk memeriksa pull request yang sama.
Pada titik ini, anda dapat bekerja pada kode. Gunakan git rebase -i dan git commit --amend untuk memastikan perbaikan mempunyai tingkatan yang diharapkan dari kualitas. Sekali anda sedang siap:
Linux / macOS
$ # Pull in the latest changes from main.\n$ git checkout main\n$ git pull upstream main\n$ # Rebase the pull request on main.\n$ git checkout pr/####\n$ git rebase main\n$ git checkout main\n$ # Merge the work as "fast-forward" to main to avoid a merge commit.\n$ # (in practice, you can omit "--ff-only" since you just rebased)\n$ git merge --ff-only pr/XXXX\n$ # If you're not sure if you did things correctly, check that only the\n$ # changes you expect will be pushed to upstream.\n$ git push --dry-run upstream main\n$ # Push!\n$ git push upstream main\n$ # Delete the pull request branch.\n$ git branch -d pr/xxxx\nWindows
...\\> REM Pull in the latest changes from main.\n...\\> git checkout main\n...\\> git pull upstream main\n...\\> REM Rebase the pull request on main.\n...\\> git checkout pr/####\n...\\> git rebase main\n...\\> git checkout main\n...\\> REM Merge the work as "fast-forward" to main to avoid a merge commit.\n...\\> REM (in practice, you can omit "--ff-only" since you just rebased)\n...\\> git merge --ff-only pr/XXXX\n...\\> REM If you're not sure if you did things correctly, check that only the\n...\\> REM changes you expect will be pushed to upstream.\n...\\> git push --dry-run upstream main\n...\\> REM Push!\n...\\> git push upstream main\n...\\> REM Delete the pull request branch.\n...\\> git branch -d pr/xxxx\nForce push to the branch after rebasing on main but before merging and pushing\nto upstream. This allows the commit hashes on main and the branch to match\nwhich automatically closes the pull request.
\nJika sebuah pull request tidak butuh digabungkan seperti banyak perbaikan, anda dapat menggunakan tombol "Squash and merge" GitHub. Sunting pesan perbaikan sesuai kebutuhan untuk menyesuaikan ke the guidelines dan pindahkan angka pull request yang otomatis ditambahkan ke baris pertama pesan.
\nKetika menulis kembali riwayat perbaikan dari pull request, tujuannya adalah membuat riwayat perbaikan django sebaik mungkin:
\nJika tambalan mengandung perbaikan bolak balik, lalu tulis kembali itu menjadi satu. Sebagai contoh, jika sebuah perbaikan menambahkan beberapa kode dan perbaikan kedua memperbaiki masalah gaya yang diperkenalkan di perbaikan pertama, perbaikan tersebut harus dilumat sebelum digabungkan.
Perubahan terpisah pada perbaikan berbeda berdasarkan pengelompokan logika: jika anda melakukan pembersihan gaya pada saat bersamaan seperti anda melakukan perubahan lain pada berkas, memisahkan perubahan kedalam dua perbaikan berbeda akan membuat meninjauan riwayat lebih mudah.
Waspada dari menggabungkan cabang upstream dalam pull request.
Percobaan harus dilewati dan dokumen harus dibangun setelah setiap perbaikan. Juga tidak percobaan maupun dokumen harus mengeluarkan peringatan.
Tambalan sepele dan kecil biasanya baik diselesaikan dalam satu perbaikan. Pekerjaan menengah sampai besar mungkin dipisah menjadi banyak perbaikan jika itu masuk akal.
Practicality beats purity, so it is up to each merger to decide how much\nhistory mangling to do for a pull request. The main points are engaging the\ncommunity, getting work done, and having a usable commit history.
\nThese guidelines apply to all commits to Django's Git repository, whether\nsubmitted by a contributor via a pull request or landed directly by a merger:
\nJangan pernah merubah riwayat telah diterbitkan dari cabang django/django dengan mendorong paksa. Jika anda mutlak harus (untuk alasan keamanan sebagai contoh), pertama obrolkan keadaan dengan tim.
For any medium-to-big changes, where "medium-to-big" is according to\nyour judgment, please bring things up on the Django Forum before making\nthe change.
\nIf you bring something up and nobody responds, please don't take that\nto mean your idea is great and should be implemented immediately because\nnobody contested it. Everyone doesn't always have a lot of time to read\ndiscussions immediately, so you may have to wait a couple of days before\ngetting a response.
\nWrite detailed commit messages in the past tense, not present tense, and\nend the subject line with a period.
\nCorrect: "Fixed Unicode bug in RSS API."
Incorrect: "Fixes Unicode bug in RSS API." (present tense)
Incorrect: "Fixing Unicode bug in RSS API." ("-ing" form)
Incorrect: "Fixed Unicode bug in RSS API" (missing trailing period)
The commit message should be in lines of 72 chars maximum. There should be\na subject line, separated by a blank line and then paragraphs of 72 char\nlines. The limits are soft. For the subject line, shorter is better.
\nIn the body of the commit message more detail is better than less, and should\nexplain why the change was made, not what was changed or how. The code\nitself shows what changed; the commit message should provide the context and\nreasoning that the code cannot.
\nCredit the contributors in the commit message: "Thanks A for the report and B\nfor review." Use git's Co-Authored-By as appropriate, including anyone\nwhose earlier work the change builds on.
\nSebagai contoh:
\nFixed #18307 -- Added git workflow guidelines.\n\nRefactored the Django's documentation to remove mentions of SVN\nspecific tasks. Added guidelines of how to use Git, GitHub, and\nhow to use pull request together with Trac instead.\n\nThanks to Full Name for the report, and to Reviewer for reviews.\nBatasi perbaikan ke perubahan paling kecil sangat masuk akal. Ini berarti, gunakan sering perbaikan kecil daripada perbaikan besar yang jarang. Sebagai contoh, jika menerapkan fitur X membutuhkan perubahan kecil pada pustaka Y, pertama perbaiki perubahan pada pustaka Y, kemudian perbaiki fitur X di perbaikan berbeda. Ini berjalan jauh dalam membantu semua orang mengikuti perubahan anda.
Separate bug fixes from feature changes. Bugfixes may need to be\nbackported.
Jika perbaikan anda menutup sebuah tiket di ticket tracker Django, mulai pesan perbaikan anda dengan teks "Fixed #xxxxx", dimana "xxxxx" adalah jumlah dari tiket perbaikan pembetulan. Contoh: "Fixed #123 -- Ditambahkan fitur ulung.". kami telah memperlengkapi Trac sehingga pesan perbaikan apapun di bentuk tersebut akan otomatis menutup acuan tiket dan penempatan komentar kepadanya dengan pesan perbaikan penuh.
\nUntuk ingin tahu, kami menggunakan `Tambahan Trac `_ untuk ini.
\nJika acuan perbaikan anda sebuah tiket di ticket tracker Django tetapi tidak menutup tiket, termasuk frase "Refs #xxxxx", dimana "xxxxx" adalah nomor dari tiket acuan perbaikan anda. Ini akan otomatis menempatkan komentar pada tiket yang sesuai.
Bug fix backports to stable branches are done exclusively by mergers, following\nthe Versi didukung. A backport consists of cherry-picking a\ncommit from main onto the target stable/A.B.x branch.
A backport commit must include two things beyond the original commit message:
\nA prefix [A.B.x] on the subject line, where A.B.x is the name of the\nstable/A.B.x branch being targeted.
A suffix Backport of <sha> from main. line in the commit body, pointing\nto the original commit hash.
Sebagai contoh:
\n[1.3.x] Fixed #17028 -- Changed diveintopython.org -> diveintopython.net.\n\nBackport of 80c0cbf1c97047daed2c5b41b296bbc56fe1d7e3 from main.\nIf the backport also fixes a regression, add a line identifying the commit that\nintroduced it:
\nRegression in 6ecccad711b52f9273b1acb07a57d3f806e93928.\nThere are three ways to do a backport, depending on your workflow:
\nOption 1: fully manual
\nCherry-pick the commit onto the stable branch, then amend the commit message to\nadd the required prefix and backport note:
\ngit cherry-pick <sha>\ngit commit --amend\nIf the cherry-pick produces conflicts, resolve them, stage the changes, then\nrun git cherry-pick --continue before amending. This option requires no\nsetup but relies entirely on remembering to format the message correctly.
Option 2: using the helper script in the repo
\nThe scripts/backport.sh Bash script automates the cherry-pick and rewrites\nthe commit message with the correct prefix and backport note. Run it from the\ntarget stable branch:
bash scripts/backport.sh <sha>\nThis is straightforward for clean cherry-picks, but if conflicts are produced,\nyou will need to resolve them manually and add the prefix and backport note to\nthe commit message yourself.
\nOption 3: using the prepare-commit-msg git hook
The scripts/prepare_commit_msg.py Python script can be installed as a\nprepare-commit-msg git hook. It automatically adds the [A.B.x] prefix\nto the subject line, appends Backport of <sha> from main. to the commit\nbody, and ensures the subject line ends with a period, even when the\ncherry-pick produces conflicts. To install it, create an executable file\n.git/hooks/prepare-commit-msg containing:
#!/bin/sh\nexec python scripts/prepare_commit_msg.py "$@"\nOnce installed, a plain git cherry-pick <sha> on a stable branch is\nsufficient; the hook handles the message formatting in all cases.
Tidak seorangpun sempurna; kesalahan akan diperbaiki.
\nBut try very hard to ensure that mistakes don't happen. Just because we have a\nreversion policy doesn't relax your responsibility to aim for the highest\nquality possible. Really: double-check your work, or have it checked by\nanother merger before you commit it in the first place!
\nKetika kesalahan perbaikan ditemukan, silahkan ikuti panduan ini:
\nJika memungkinkan, penulis asli mengembalikan perbaikan mereka sendiri.
Jangan mengembalikan perubahan penulis lain tanpa perizinan dari penulis asli.
Gunakan git revert -- ini akan membuat membalikkan perbaikan, tetapi perbaikan asli akan masih menjadi bagian dari riwayat perbaikan.
If the original author can't be reached (within a reasonable amount\nof time -- a day or so) and the problem is severe -- crashing bug,\nmajor test failures, etc. -- then ask for objections on the Django Forum\nthen revert if there are none.
Jika masalah adalah kecil (perbaikan fitur setelah pembekuan fitur, katakan), tunggu saja.
If there's a disagreement between the merger and the reverter-to-be then try\nto work it out on the Django Forum . If an agreement can't be reached then\nit should be put to a vote.
Jika perbaikan diperkenalkan ditegaskan, ungkap kerentanan keamanan kemudian perbaikan mungkin dirubah sesegera mungkin tanpa perizinan dari siapapun.
Perawat cabang terbitan mungkin mengeluarkan perbaikan ke cabang terbitan tanpa perizinan jika perbaikan merusak cabang terbitan.
Jika anda salah mendorong sebuah cabang topik ke django/django, hapus itu. Sebagai contoh, jika anda melakukan git push upstream feature_antigravity, lakukan dorongan balikan: git push upstream :feature_antigravity.