Memperbaiki kode

Bagian ini dialamatkan ke pembetul dan siapapun yang tertarik dalam mengetahui bagaimana kode diperbaiki kedalam Django. Jika anda adalah anggota komunitas yang ingin membantu kode pada Django, lihatlah doc:writing-code/working-with-git sebagai gantinya.

Penanganan pull request

Sejak Django disimpan pada GitHub, tambalan disediakan dalam formulir dari pull request.

Ketika memperbaiki pull request, pastikan setiap perbaikan perorangan cocok dengan panduan perbaikan digambarkan dibawah. Penyumbang diharapkan untuk menyediakan kemungkinan pull request terbaik. Dalam praktiknya bagaimanapun, pembuat perbaikan - yang akan lebih akrab dengan panduan perbaikan - mungkin memutuskan membawa perbaikan ke standar mereka sendiri.

Anda mungkin ingin memiliki Jenkin mencoba pull request dengan satu dari pembangun pull request yang tidak berjalan otomatis, seperti Oracle atau Selenium. Lihat Jenkins wiki page untuk petunjuk.

Jika anda menemukan anda sendiri memeriksa pull request secara lokal lebih sering, nama lain git ini akan membantu:

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

Tambahkan ke ~/.gitconfig anda, dan setel upstream menjadi django/django. Kemudian anda dapat menjalankan git pr #### utnuk 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:

$ # 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

Force push to the branch after rebasing on main but before merging and pushing to upstream. This allows the commit hashes on main and the branch to match which automatically closes the pull request.

Jika 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.

Ketika menulis kembali riwayat perbaikan dari pull request, tujuannya adalah membuat riwayat perbaikan django sebaik mungkin:

  • Jika 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.

Secara praktis mengalahkan kemurnian, jadi itu terserah pada setiap pembuat perbaikan untuk memutuskan berapa banyak riwayat mengoyak dilakukan untuk pull request. Titik utama adalah menarik komunitas, menyelesaikan pekerjaan, dan memiliki riwayat perbaikan yang berguna.

Panduan perbaikan

Sebagai tambahan, silahkan ikuti panduan berikut ketika memperbaiki kode pada gudang Git Django:

  • Jangan 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.

  • Untuk tiap perubahan sedang-ke-besar, dimana "sedang-ke-besar" adalah menurut penilaian anda, harap bawa hal-hal di daftar penyuratan django-developers sebelum membuat perubahan.

    Jika anda membawa sesuatu pada django-developers dan tidak seorangpun menanggapi, harap jangan ambil itu berarti ide anda hebat dan harus diterapkan segera mungkin karena tidak seorangpun menentangnya. Setiap orang tidak selalu mempunyai banyak waktu untuk membaca obrolan daftar penyuratan dengan segera, jadi anda mungkin harus menunggu beberapa hari sebelum mendapatkan sebuah tanggapan.

  • Tulis rincian pesan perbaikan di waktu lampau, bukan waktu ini.

    • Bagus: "Memperbaiki kesalahan Unicode dalam API RSS."
    • Buruk: "Memperbaiki kesalahan Unicode dalam API RSS."
    • Buruk: "Memperbaiki kesalahan Unicode dalam API RSS."

    Pesan perbaikan harus berada di baris dari maksimum 72 karakter. Harus ada baris subjek, dipisah oleh baris kosong dan kemudian paragraf dari 72 baris karakter. Batasannya lembut. Untuk baris subjek, lebih pendek lebih baik. Di badan dari pesan perbaikan lebih rinci adalah lebih baik dari pada sedikit:

    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.
    

    Beri penghargaan pada kontributor dalam pesan commit: "Thanks A for the report and B for review." Gunakan Co-Authored-By git sewajarnya.

  • Untuk perbaikan pada cabang, awalai pesan perbaikan dengan nama cabang. Sebagai contoh: "[1.4.x] Fixed #xxxxx -- Ditambahkan dukungan untuk pembacaan pikiran."

  • Batasi 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.

  • Perbaikan-perbaikan kesalahan dari perubahan fitur. Perbaikan kesalahan mungkin butuh dihubungkan ke cabang stabil, menurut Versi didukung.

  • 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.

    Untuk ingin tahu, kami menggunakan `Tambahan Trac `_ untuk ini.

Catatan

Catat bahwa perpaduan Trac tidak mengetahui apapun tentang pull request. Jadi jika anda mencoba menutup pull request dengan frase "closes #400" dalam pesan perbaikan anda, GitHub akan menutup pull request, tetapi tambahan Trac akan juga menutup nomor tiket sama di Trac.

  • Jika 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.

  • Tulis pesan perbaikan untuk backport menggunakan pola berikut:

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

    Sebagai contoh:

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

    Terdapat tulisan pada wiki <https://code.djangoproject.com/wiki/CommitterTips#AutomatingBackports>`_ untuk mengotomatisasi ini.

    Jika commit memperbaiki pemulihan, sertakan ini dalam pesan commit:

    Regression in 6ecccad711b52f9273b1acb07a57d3f806e93928.
    

    (gunakan campuran commit dimana pemulihan diperkenalkan).

Mengembalikan perbaikan

Tidak seorangpun sempurna; kesalahan akan diperbaiki.

Tetapi coba dengan keras untuk memastikan bahwa kesalahan tidak terjadi. Hanya karena kami mempunyai kebijakan pengembalian tidak mengendurkan tanggung jawab anda untuk mengarahkan kemungkinan kualitas tertinggi. Benar: periksa dua kali pekerjaan anda, atau biarkan itu diperiksa oleh pembuat perbaikan lain, sebelum anda memperbaiki itu di tempat pertama!

Ketika kesalahan perbaikan ditemukan, silahkan ikuti panduan ini:

  • Jika 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.
  • Jika penulis asli tidak dapat meraih (dalam sejumlah waktu yang beralasan -- sehari atau lebih) dan masalah parah -- benar-benar kesalahan, kegagalan percobaan besar, dll. -- kemudian minta untuk keberatan pada daftar penyuratan django-developers kemudian pulihkan jika ada satu.
  • Jika masalah adalah kecil (perbaikan fitur setelah pembekuan fitur, katakan), tunggu saja.
  • Jika ada ketidaksetujuan diantara pembuat perbaikan dan pembuat kebalikan menjadi kemudian coba bekerja dengannya pada daftar penyuratan django-developers. Jika sebuah persetujuan tidak dapat dicapai kemudian itu harus ditaruh ke pemilihan.
  • 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.
Back to Top