Memperbaiki kode

Bagian ini dialamatkan ke Pembuat Perbaikan dan siapapun yang tertarik dalam mengetahui bagaimana kode diperbaiki kedalam inti Django. Jika anda adalah anggota komunitas yang ingin membantu kode pada Django, lihatlah ini Bekerja dengan Git dan GitHub sebagai gantinya.

Penanganan pull request

Sejak Django sekarang disimpan pada GitHub, kebanyakan tambalan disediakan di formulir 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.

Catatan

Sebelum menggabungkan, tetapi setelah meninjau, lakukan percobaan Jenkins pull request dengan mengkomentarkan “buildbot, test this please” pada PR. Lihat Jenkins wiki page kami untuk lebih rinci.

Sebuah cara mudah untuk memeriksa pull request secara lokal adalah sebuah nama lain pada ~/.gitconfig anda (upstream dianggap menjadi django/django):

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

Sekarang anda dapat dengan mudah menjalankan git pr #### untuk memeriksa permintaan pull request.

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 master.
$ git checkout master
$ git pull upstream master
$ # Rebase the pull request on master.
$ git checkout pr/####
$ git rebase master
$ git checkout master
$ # Merge the work as "fast-forward" to master 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 master
$ # Push!
$ git push upstream master
$ # Delete the pull request branch.
$ git branch -d pr/xxxx

Untuk perubahan pada cabang anda sendiri, paksa dorong ke cabang anda setelah rebase pada master tetapi sebelum menggabungkan dan mendorong ke upstream. Ini mengizinkan potongan-potongan perbaikan pada master dan cabang anda untuk cocok yang otomatis menutup pull request. Sejak anda tidak dapat mendorong ke cabang-cabang penyumbang lain, komentar pada pull request “Merged in XXXXXXX” (mengganti dengan potongan perbaikan) setelah anda menggabungkannya. Trac memeriksa untuk bentuk pesan ini untuk menunjukkan pada halaman halaman tiket apakah atau tidak pull request digabungkan.

Hindari menggunakan tombol “Merge pull request” GitHub pada website karena akan membuat “merge commit” yang tidak baik dan membuat navigasi riwayat lebih susah.

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. Pengembang inti Django tidak mempunyai banyak waktu untuk membaca obrolan daftar-penyuratan dengan segera, jadi anda mungkin harus menunggu beberapa hari sebelum mendapatkan 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.

    Jika tambalan bukan pull request, anda harus menghormati penyumbang dalam pesan perbaian: “Terima kasih A untuk laporan, B untuk tambalan dan C untuk tinjauan.”

  • 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 pengembang inti Django mengikuti perubahan anda.

  • Pisahkan perbaikan kesalahan dari perubahan fitur. Perbaikan kesalahan mungkin butuh disambungkan ke cabang stabil, menurut kebijakan kecocokan-sebelumnya.

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

    Jika perbaikan anda menutup tiket dan berada di cabang, gunakan namac abang terlebih dahulu, kemudian “Fixed #xxxxx.” Sebagai contoh: “[1.4.x] Fixed #123 – Ditambahkan fitur ulung.”

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

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

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 topik cabang ke django/django, cukup hapus itu. Sebagai contoh, jika anda melakukan: git push upstream feature_antigravity, cukup lakukan membalikkan pendorongan: git push upstream :feature_antigravity.

Back to Top