Mengajukan tambalan

Kami semua selalu berterima kasih untuk tambalan-tambalan pada kode Django. Memang, laporan kesalahan dengan tambalan terhubung akan diperbaiki jauh lebih cepat daripada mereka yang tanpa tambalan.

Perbaikan kesalahan ketik dan perubahan dokumentasi sepele.

Jika anda sedang memperbaiki masalah sepele, sebagai contoh merubah sebuah kata di dokumentasi, cara dipilih untuk menyediakan tambalan adalah menggunakan menarik permintaan GitHub tanpa tiket Trac.

Lihat Bekerja dengan Git dan GitHub untuk rincian lebih bagaimana menggunakan pull request.

Tiket “Meminta”

Dalam sebuah proyek sumber-terbuka dengan ratusan penyumbang diseluruh dunia, adalah sangat penting untuk mengelola komunikasi secara efektif sehingga pekerjaan tidak ganda dan penyumbang dapat menjadi seefektif mungkin.

Oleh sebab itu, kebijakan kami untuk penyumbang dalam “menagih” tiket agar membiarkan pengembang lain mengetahui bahwa kesalahan atau fitur tertentu sedang dikerjakan.

Jika anda telah mencirikan bantuan anda ingin membuat dan anda mampu memperbaikinya (yang diukur dengan kemampuan pengkodean anda, pengetahuan dari internal Django dan ketersediaan waktu), tagih dia dengan mengikuti langkah-langkah berikut:

  • Login using your GitHub account atau create an account di sistem tiket kami. Jika anda mempunyai sebuah akun tetapi lupa sandi anda, anda dapat mengatur kembali menggunakan password reset page.

  • Jika sebuah tiket untuk masalah ini belum ada, buat satu di ticket tracker kami.

  • Jika tiket untuk masalah ini sudah ada, pastikan tidak seorangpun telah menagihnya. Untuk melakukan ini, lihat bagian “Owned by” dari tiket. Jika dia ditentukan ke “nobody”, kemudian itu tersedia untuk ditagih. Jika tidak, seseorang lain mungkin bekerja pada tiket untuk menawarkan bantuan anda. Jika tiket diberikan selama mingguan atau bulanan tanpa aktivitas apapun, itu mungkin aman untuk ditetapkan untuk diri anda sendiri.

  • Masuk kedalam akun anda, jika anda belum, dengan mengklik “GitHub Login” atau “DjangoProject Login” di kiri atas dari halaman tiket.

  • Tagih tiket dengan mengklik tombol radio “assign to myself” dibawah “Action” dekat bawah halaman, kemudian klik “Submit changes.”

Catatan

Yayasan perangkat lunak Django meminta bahwa siapapun yang menyumbang lebih dari tambalan sepele pada Django menandatangani dan mengirimkan Contributor License Agreement, ini memastikan bahwa Django Software Foundation mempunyai lisensi jelas untuk semua bantuan mengizinkan untuk lisensi jelas untuk semua pengguna.

Tanggung jawab pengaku tiket

Sekali anda mengakui sebuah tiket, anda mempunyai tanggung jawab untuk bekerja pada tiket tepat waktu. Jika anda tidak mempunyai waktu untuk bekerja padanya, salah satu batalkan pengakuannya atau jangan mengakuinya di tempat pertama!

Jika tidak ada tanda kemajuan pada tiket tertentu yang diakui selama seminggu atau dua minggu, pengembang lain mungkin meminta anda melepaskan pengakuan tiket sehingga itu tidak lagi dikuasai dan seseorang lain dapat mengakuinya.

Jika anda telah mengakui tiket dan itu memakan waktu lama (harian atau mingguan) untuk membuat kode, jaga semua orang terperbaharui dengan menempatkan komentar pada tiket. Jika anda tidak menyediakan pembaharuan reguler, dan anda tidak menjawab pada permintaan untuk laporan kemajuan, pengakuan anda pada tiket mungkin ditarik.

Seperti biasa, komunikasi lebih lebih baik daripada komunikasi kurang!

Tiket mana harus diminta?

Tentu saja, melalui langkah-langkah dari pengakuan tiket berlebihan dalam beberapa kasus.

Di kasus perubahan kecil, seperti salah ketik di dokumentasi atau kesalahan kecil yang hanya akan memakan beberapa menit untuk memperbaikinya, anda tidak perlu lompat melalui lingkaran dari pengakuan tiket. Cukup ajukan tambalan dan dilakukan dengan hal itu.

Tentu saja, itu selalu diterima, tanpa memperhatikan apakah seseorang telah mengakuinya atau tidak, untuk mengajukan tambalan ke tiket jika anda terjadi mempunyai tambalan siap.

Gaya tambalan

Pastikan bahwa tiap sumbangan anda lakukan memenuhi setidaknya persyaratan berikut:

  • Kode wajib untuk memperbaiki sebuah masalah atau menambah sebuah fitur adalah bagian terpenting dari sebuah tambalan, tetapi itu bukan satu-satunya bagian. Tambalan bagus harus juga menyertakan regression test untuk memeriksa keabiasaan yang telah diperbaiki dan mencegah masalah dari muncul kembali. Juga, jika beberapa tiket terkait ke kode anda telah tulis, sebutkan angka tiket di beberapa komentar di percobaan sehingga satu dapat dengan mudah dilacak obrolan terkait setelah tambalan anda mendapatkan perbaikan, dan tiket ditutup.

  • Jika kode terhubung dengan tambalan menambahkan fitur baru, atau merubah kebiasaan dari fitur yang ada, tambalan harus juga mengandung dokumentasi.

Ketika anda berpikir pekerjaan anda siap ditinjau, kirim a GitHub pull request. Harap tinjau tambalan sendiri menggunakan patch review checklist terlebih dahulu.

Jika anda tidak dapat pull request untuk beberapa alasan, anda dapat juga menggunakan tambalan-tambalan di Trac. Ketika menggunakan gaya ini, ikuti panduan berikut.

  • Ajukan tambalan-tambalan dalam bentuk dikembalikan oleh perintah git diff.

  • Lampirkan tambalan ke sebuah tiket dalam ticket tracker, menggunakan tombol “attach file”. Tolong jangan taruh tambalan dalam gambaran tiket atau komentar meskipun dia hanya sebuah tambalan baris tunggal.

  • Nama berkas tambalan dengan perpanjangan .diff; ini akan membuat pelacak tiket memberlakukan penyorotan sintaksis benar, yang tentunya sangat membantu.

Tanpa memperhatikan cara anda mengajukan pekerjaan anda, ikuti langkah-langkah ini.

  • Pastikan anda memenuhi persyaratan di daftar centang pratinjau tambalan kami.

  • Centang kotak “Has patch” pada tiket dan pastikan kotak-kotak “Butuh dokumentasi”, “Butuh percobaan”, and “Tambalan butuh perbaikan” tidak dicentang. Ini membuat tiket muncul di antrian “Tambahan butuh ditinjau” pada Development dashboard.

Tambalan bukan sepele

Tambalan “bukan-sepele” adalah satu yang lebih dari sebuah perbaikan kesalahan sederhana. Itu adalah sebuah tambalan yang memperkenalkan fungsi Django dan membuat beberapa urutan keputusan rancangan.

Jika anda menyediakan tambalan bukan-sepele, sertakan saksi yang jalan lain telah diobrolkan di django-developers.

Jika anda tidak yakin apakah tambalan anda harus dipertimbangkan bukan-sepele, tanya saja.

Mengusangkan fitur

Terdapat beberapa alasan bahwa kode di Django mungkin diusangkan:

  • Jika sebuah fitur telah ditingkatkan atau dirubah di cara ketidaksesuaian-kebelakang, fitur atau kebiasaan lama akan diusangkan.

  • Terkadang Django akan menyertakan backport dari pustaka Python yang tidak disertakan dalam versi dari Python yang Django saat ini dukung. Ketika Django tidak lagi butuh mendukung versi lama dari Python yang tidak menyertakan pustaka, pustakan akan diusangkan di Django.

Seperti deprecation policy gambarkan, terbitan pertama dari Django yang mengusangkan sebuah fitur (A.B) harus memunculkan RemovedInDjangoXXWarning (dimana XX adalah versi Django dimana fitur akan dipindahkan ketika fitur diusangkan dipanggil. Menganggp kami mempunyai cakupan percobaan baik, peringatan ini dirubah ke kesalahan ketika running the test suite dengan peringatan diadakan: python -Wall runtests.py. Dengan demikian, ketika menambahkan RemovedInDjangoXXWarning anda butuh mengurangi atau mensenyapkan tiap peringatan yang dibangkitkan ketika menjalankan percobaan.

Langkah pertama adalah memindahkan tiap penggunaan dari kebiasaan diusangkan oleh Django itu sendiri. Selanjutnya anda dapat peringatan senyap di percobaan yang sebenarnya mencoba kebiasaan diusangkan dengan menggunakan penghias ignore_warnings, antara pada tingkatan percobaan atau kelas:

  1. Di percobaan khusus:

    from django.test import ignore_warnings
from django.utils.deprecation import RemovedInDjangoXXWarning

@ignore_warnings(category=RemovedInDjangoXXWarning)
def test_foo(self):
    ...

  2. Untuk kasus percobaan keseluruhan:

    from django.test import ignore_warnings
from django.utils.deprecation import RemovedInDjangoXXWarning

@ignore_warnings(category=RemovedInDjangoXXWarning)
class MyDeprecatedTests(unittest.TestCase):
    ...

Anda dapat juga menambahkan sebuah percobaan untuk peringatan pengusangan. Anda harus meniadakan kebiasaan “peringatan sebagai kesalahan” di percobaan anda dengan melakukan:

import warnings

def test_foo_deprecation_warning(self):
    with warnings.catch_warnings(record=True) as warns:
        warnings.simplefilter('always')  # prevent warnings from appearing as errors
        # invoke deprecated behavior

    self.assertEqual(len(warns), 1)
    msg = str(warns[0].message)
    self.assertEqual(msg, 'Expected deprecation message')

Akhirnya, ada sepasang pembaharuan ke dokumentasi Django untuk dibuat:

  1. Jika fitur yang ada didokumentasikan, tandai dia diusangkan di dokumentasi menggunakan keterangan .. deprecated:: A.B. Termasuk gambaran pendek dan catatan tentang jalur peningkatan jika berlaku.

  2. Tambah gambaran dari kebiasaan pengusangan, dan tingkatkan jalur jika dapat diterapkan, pada catatan terbitaan saat ini (docs/releases/A.B.txt) dibawah kepala “Fitur-fitur diusangkan dalam A.B”.

  3. Tambah sebuah masukan dalam linimasa pengusangan (docs/internals/deprecation.txt) dibawah versi yang sesuai menggambarkan kode apa akan dipindahkan.

Sekali anda telah melengkapi langkah ini, anda selesai dengan pengusangan. Di setiap feature release, semua RemovedInDjangoXXWarning yang cocok versi baru dipindahkan.

Tambalan JavaScript

Untuk informasi pada tambalan JavaScript, lihat dokumentasi Tambalan JavaScript.

Daftar centang pratinjau tambalan

Gunakan daftar centang ini untuk meninjau sebuah pull request. Jika anda sedang meninjau sebuah pull request yang bukan milik anda dan itu lolos semua kriteria dibawah, harap setel “Triage Stage” pada tiket Trac sesuai pada “Siap untuk diperiksa”. Jika anda telah meninggalkan komentar untuk perbaikan pada pull request, silahkan tandai bendera sesuai pada Trac berbasis tiket pada hasil dari tinjauan anda: “Tambalan butuh perbaikan”, “Butuh dokumentasi”, and/or “Butuh percobaan”. Sebagai perizinan waktu dan minat, pengembang inti melakukan tinjauan akhir dari tiket “Siap untuk diperiksa” dan akan antara memperbaiki tambalan atau membenturkannya kembali ke “Diterima” jika pekerjaan lanjutan butuh diselesaikan. Jika anda sedang mencari untuk menjadi pengembang inti, melakukan tinjauan seksama dari tambalan adalah jalan hebat untuk mendapatkan kepercayaan.

Mencari tambalan untuk ditinjau? Periksa bagian “Patches needing review” dari Django Development Dashboard. Mencari untuk mendapatkan tambalan anda ditinjau? Pastikan bendera Trac pada tiket disetel sehingga tiket muncul di antrian itu.

Dokumentasi

  • Apakah dokumentasi dibangun tanpa kesalahan apapun (make html, atau make.bat html pada Windows, dari direktori docs)?

  • Apakah dokumentasi mengikuti panduan gaya penulisan dalam Menulis dokumentasi?

  • Apakah ada kesalahan pengejaan?

Kesalahan

  • Apakah ada percobaan pemulihan yang sesuai (percobaan harus gagal sebelum perbaikan diberlakukan)?

Fitur Baru

  • Apakah ada percobaan untuk “latihan” semua kode baru?

  • Apakah ada sebuah catatan terbitan di docs/releases/A.B.txt?

  • Apakah ada dokumentasi untuk fitur dan apakah dia dijelaskan dengan tepat dengan .. versionadded:: A.B atau .. versionchanged:: A.B?

Mengusangkan fitur

Lihat panduan Mengusangkan fitur.

Semua kode perubahan

  • Apakah coding style sesuai pada panduan kami? Apakah ada kesalahan flake8?

  • Jika perubahan adalah kesesuaian kebelakang denganc ara apapun, apakah ada dalam catatan terbitan (docs/releases/A.B.txt)?

  • Apakah deretan percobaan Django lolos? Tanya di #django-dev untuk pengembang inti untuk membangun pull request terhadap peladen perpaduan kelanjutan kami

Semua tiket

Back to Top