Mendahulukan tiket

Django menggunakan Trac mengelola pekerjaan pada basis kode. Trac adalah taman cenderung-komunitas dari kesalahan orang telah menemukan dan fitur orang akan senang melihat ditambahkan. Seperti di taman manapun, terkadang ada gulma untuk ditarik dan terkada ada bunga dan sayuran yang butuh dipetik. Kami butuh bantuan anda untuk mengurutkan satu dari lainnya, dan pada akhirnya kami semua beruntung bersama-sama.

Seperti semua taman, kami dapat becita-cita untuk penyempurnaan tetapi kenyataannya tidak ada hal tersebut. Bahkan di taman paling asli masih ada keong dan serangga. Di taman komunitas ada juga membantu orang yang -- dengan niat terbaik -- menyuburkan gulma dan meracuni mawar. Itu tugas dari komunitas sebagai keseluruhan untuk pengelolaan-sendiri, jaga masalah sampai minimum, dan didik yang datang ke dalam komunitas sehingga mereka dapat menjadi anggota penyumbang berharga.

Demikan pula, selagi kita menyasar untuk Trac menjadi perwakilan sempurna dari keadaan kemajuan Django, kami mengakui bahwa ini tidak akan terjadi. Dengan menyebarkan muatan perawatan Trac ke komunitas, kami menerima bahwa ada kesalahan. Trac "kebanyakan paling akurat", dan kami memberikan kelonggaran untuk fakta bahwa terkadang itu akan salah. Tidak mengapa. Kami ingin sempurna dengan tenggat waktu.

Kami bergantung pada komunitas untuk terus ikut serta, menjaga tiket seakurat mungkin, dan menimnulkan masalah-masalah untuk diobrolkan pada daftar penyuratan kami ketika ada kebingungan dan ketidaksetujuan.

Django adalah proyek komunitas, dan setiap bantuan membantu. Kami tidak dapat melakukan ini tanpa anda!

Alur kerja Triage

Sayangnya tidak semua laporan kesalahan dan permintaan fitur di pelacak tiket menyediakan semua required details. Angka dari tiket mempunyai tambalan, tetapi tambalan tersebut tidak memenuhi semua persyaratan dari good patch.

Satu cara untuk membantu adalah memberikan tiket yang telah dibuat oleh pengguna lain.

Kebanyakan alurkerja berdasarkan seputar konsep dari triage stages tiket. Setiap tahapan menggambarkan dimana didalam siklus hidupnya tiket yang diberikan adalah kapan saja. Bersama dengan bendera-bendera yang sangat membantu, atribut ini dengan mudah memberitahu kami bahwa apa dan siapa setiap tiket sedang menunggu.

Sejak gambar berharga seribu kata, mari kita mulai disana:

Kami telah mendapat dua peran pada diagram ini:

• Pembuat perbaikan: orang dengan akses perbaikan yang bertanggungjawab untuk membuat keputusan akhir untuk menggambungkan sebuah tambalan.
• Pemilih tiket: siapapun dalam komunitas Django yang memilih menjadi terlibat di pengolahan pengembangan Django. Pemasangan Trac kami sengaja dibiarkan terbuka ke umum, dan siapapun dapat memilih tiket. Django adalah proyek komunitas, dan kami mendorong triage by the community.

Sebagai contoh, disini kita melihat daur hidup dari sebuah tiket rata-rata:

• Alice membuat sebuah tiket dan mengirim sebuah tambalan tidak lengkap (tidak ada pengujian, penerapan tidak benar).
• Bob meninjau pull request, menandai tiket sebagai "Diterima", "butuh pengujian", dan "tambalan butuh perbaikan", dan meninggalkan komentar mengatakan ke Alice bagaimana tambalan dapat diperbaiki.
• Alice memperbaharui pull request, menambahkan percobaan (tetapi tidak merubah penerapan). Dia memindahkan dua bendera.
• Charlie meninjau pull request dan menyetel kembali bendera "tambalan membutuhkan perbaikan" dengan komentar lain tentang memperbaiki penerapan.
• Alice memperbaharui pull request, memperbaiki penerapan. Dia memindahkan bendera "tambalan butuh diperbaiki".
• Daisy meninjau pull request, dan menandai tiket sebagai "Siap untuk mendaftar".
• Jacob, seorang pembuat perbaikan, meninjau pull request dan menggabungkan itu.

Beberapa tiket membutuhkan sedikit umpan balik daripada ini, tapi kembali lagi beberapa tiket membutuhkan lebih banyak.

Tahapan-tahapan Triage

Dibawah ini kami menggambarkan dalam lebih rinci beragam tingkatan dimana sebuah tiket mungkin mengalir selama siklus hidupnya.

Belum ditinjau

Tiket belum ditinjau oleh seorangpun yang merasa berkualitas untuk membuat keputusan tentang apakah tiket mengandung masalah sah, fitur yang berjalan terus, atau mungkin menutup untuk beragam alasan.

Diterima

Kawasan abu-abu besar! Arti mutlak dari "diterima" adalah bahwa masalah digambarkan dalam tiket adalah sah dan dalam beberapa tingkatan sedang dikerjakan. Diluar itu ada beberapa pertimbangan:

• Diterima + Tidak ada Bendera

  Tiket sah, tetapi tidak seorangpun mengajukan sebuah tambalan untuknya. Sering ini berarti anda dapat dengan aman memulai menulis tambalan untukn itu. Ini umumnya lebih benar untuk kasus dari kesalahan diterima daripada fitur diterima. Sebuah tiket untuk sebuah kesalahan yang telah diterima berarti bahwa masalah telah diperiksa oleh setidaknya satu penyortir sebagai kesalahan sah - dan harus diperbaiki jika memungkinkan. Sebuah fitur baru diterima hanya berarti bahwa satu penyortir berpikir akan bagus jika punya, tetapi ini sendiri tidak mewakili sebuah pandangan pemufakatan atau berarti dengan kepastian apapun yang sebuah tambalan akan diterima untuk fitur tersebut. Cari lebih umpan balik sebelum menulis tambalan tambahan jika anda ragu.

• Diterima + Ada Tambalan

  Tiket menunggu untuk orang untuk meninjau tambalan dipasok. Ini berarti mengunduh tambalan dan mencobanya, memeriksa bahwa itu mengandung percobaan dan dokumen, menjalankan deretan percobaan dengan tambalan disertakan, dan meninggalkan umpan balik pada tiket.

• Diterima + Ada Tambalan + Dibutuhkan ...

  Ini berarti tiket telah ditinjau, dan telah ditemukan untuk pekerjaan lebih lanjut. "Butuh Percobaan" dan "Butuh dokumentasi" adalah penjelasan-sendiri. "Butuh perbaikan tambalan" akan umumnya ditemani oleh komentar pada tiket menjelaskan apa yang dibutuhkan untuk memperbaiki kode.

Siap Untuk Mendaftar

The ticket was reviewed by any member of the community other than the person who supplied the patch and found to meet all the requirements for a commit-ready patch. A committer now needs to give the patch a final review prior to being committed.

There are a lot of pull requests. It can take a while for your patch to get reviewed. See the contributing code FAQ for some ideas here.

Suatu hari/Mungkin

Tahapan ini tidak ditampilkan pada diagram. Itu dengan hemat untuk tetap melacak dari ide tingkat-tinggi atau permintaan fitur jangka panjang.

Tiket ini tidak umum dan keseluruhan kurang berguna sejak mereka tidak menggambarkan masalah nyata ditindaklanjuti. Mereka meningkatkan permintaan bahwa kami mungkin mempertimbangkan menambahkan suatu waktu ke kerangka jika sebuah tambalan sempurna diajukan. Mereka bukan prioritas tinggi.

Atribut triage lainnya

Sejumlah bendera, muncul sebagai kotak centang di Trac, dapat di setel di tiket:

Memiliki Tambalan

INi berarti tiket mempunyai sebuah patch terhubung. Ini akan ditinjau kembali untuk melihat jika tambalan ini "baik".

Tiga bidang berikut (Butuh dokumentasi, Butuh percobaan, Tambalan butuh perbaikan) berlaku jika sebuah tambalan telah dipasok.

Butuh dokumentasi

Bendera ini digunakan untuk tiket dengan tambalan yang butuh dokumentasi terkait. Dokumentasi lengkap dari fitur adalah prasyarat sebelum kami dapat memerika mereka ke dalam basiskode.

Butuh pengujian

Ini menandai tambalan yang membutuhkan unit percobaan terkait. Kembali, ini adalah bagian diwajibkan dari tambalan sah.

Tambalan butuh perbaikan

Bendera ini berarti bahwa meskipun tiket mempunyai tambalan, itu tidak siap untuk pendaftaran. Ini daat berarti tambalan tidak lagi berlaku, ada sebuah cacat dalam penerapan, atau bahwa kode tidak memenuhi standar kami.

Pengambilan mudah

Tiket yang akan membutuhkan kecil, mudah, tambalan.

Tipe

Tiket harus dikelompokkan berdasarkan jenis diantara:

• Fitur Baru

  Untuk menambahkan sesuatu baru.

• Kesalahan

  Untuk ketika hal yang ada rusak atau tidak berperilaku seperti yang diharapkan.

• Pembersihan/optimalisasi

  Untuk ketika tidak ada yang rusak tetapi sesuatu dapat dibuat lebih jelas, lebih baik, lebih cepat, lebih kuat.

Komponen

Tiket harus dikelompokkan kedalam komponen menandakan milik kawasan mana dari basiskode Django. Ini membuat tiket lebih baik tersusun dan lebih mudah ditemukan.

Kesederhanaan

Atribut keparahan digunakan untuk mencirikan pemblok, yaitu, masalah-masalah yang harus segera diperbaiki sebelum menerbitkan versi selanjutnya dari Django. Khususnya masalah-masalah itu adalah kesalahan disebabkan pemulihan dari versi sebelumnya atau berpotensi menyebabkan kehilangan data parah. Atribut ini sangat jarang digunakan dan mayoritas jumlah besar tiket mempunyai keparahan "Normal".

Versi

Itu dimungkinkan menggunakan atribut versi untuk menandakan versi mana kesalahan dilaporkan telah dicirikan.

UI/UX

Bendera ini digunakan untuk tiket yang terkait ke Antarmuka Pengguna dan pertanyaan Pengalaman pengguna. Sebagai contoh, bendera ini akan sesuai untuk pengguna-menghadapi fitur dalam formulir atau antarmuka admin.

Cc

Anda mungkin menambahkan nama pengguna atau alamt surel ke bidang ini untuk diberitahu ketika bantuan baru dibuat ke tiket.

Kata kunci

Dengan bidang ini anda memungkinkan menandakan sebuah tiket dengan banyak kata kunci. Ini dapat berguna, sebagai contoh, untuk mengelompokkan beberapa tiket dari tema sama. Kata kunci dapat juga dipisahkan dengan koma atau spasi. Kata kunci pencarian mencari deretan karakter dimanapun dalam kata kunci. Sebagai contoh, mengklik pada tiket dengan katakunci "form: akan menghasilkan tiket mirip ditandai dengan kata kunci mengandung deretan karakter seperti "formset", "modelformset", dan "ManagementForm".

Menutup Tiket

When a ticket has completed its useful lifecycle, it's time for it to be closed. Closing a ticket is a big responsibility, though. You have to be sure that the issue is really resolved, and you need to keep in mind that the reporter of the ticket may not be happy to have their ticket closed (unless it's fixed!). If you're not certain about closing a ticket, leave a comment with your thoughts instead.

Jika anda menutup sebuah tiket, anda harus selalu memastikan berikut:

• Pastikan bahwa masalah terselesaikan.
• Tinggalkan komentar menjelaskan keputusan untuk menutup tiket.
• JIka ada cara mereka dapat memperbaiki tiket untuk membukanya, biarkan mereka mengetahui.
• Jika tiket ganda, acukan tiket asli. Juga periksa acuan tiket tertutup dengan meninggalkan komentar dalam satu yang asli -- ini mengizinkan untuk mengakses lebih informasi terkait tentang kesalahan dilaporkan atau fitur diminta.
• Sopanlah Tidak seorangpun suka tiket milik mereka tutup. Itu dapat mengecewakan atau bahkan mengecilkan. Jalan terbaik untuk menghindari merubah orang dari membantu ke Django adalah menjadi sopan dan ramah dan untuk menawarkan saran untuk bagaimana mereka dapat memperbaiki tiket ini dan tiket lainnya di masa depan.

Sebuah tiket dapat diselesaikan dalam sejumlah jalan:

• diperbaiki

  Digunakan ketika sebuah tambalan telah digulirkan kedalam Django dan masalah diperbaiki.

• tidak sah

  Digunakan jika tiket ditemukan tidak benar. Ini berarti bahwa masalah dalam tiket sebenarnya hasil dari kesalahan pengguna, atau menggambarkan sebuah masalah dengan sesuatu selain daripada Django, atau bukan laporan kesalahan atau permintaan kesalahan (sebagai contoh, beberapa pengguna baru mengajukan permintaan dukungan sebagai tiket).

• wontfix

  Digunakan ketika seseorang memutuskan bahwa permintaan tidak sesuai untuk pertimbangan dalam Django. Terkadang sebuah tiket ditutup sebagai "wontfix" dengan sebuah permintaan untuk pelapor memulai sebuah obrolan pada daftar penyuratan django-developers jika mereka merasakan berbeda dari alasan disediakan oleh orang yang menutup tiket. Lain kali, sebuah obrolan daftar penyuratan mendahului keputusan untuk menutup sebuah tiket. Selalu gunakan daftar penyuratan untuk mendapatkan sebuah pemufakatan sebelum membuka kembali tiket-tiket ditutup sebagai "wontfix".

• rangkap

  Digunakan ketika tiket lainnya menutuoi masalah sama. Dengan menutup tiket ganda, kami menjaga semua obrolan dalam satu tempat, yang membantu semua orang.

• worksforme

  Digunakan ketika tiket tidak mengandung cukup rincian untuk mengulangi kesalahan asli.

• needsinfo

  Digunakan ketika tiket tidak mengandung cukup informasi untuk mengulangi masalah dilaporkan tetapi masih berpotensi sah. Tiket harus dibuka kembali ketika informasi lebih dipasok.

Jika anda percaya bahwa tiket yang telah ditutup dalam salah -- karena anda masih mempunyai masalah sama, atau penyortir telah membuat sebuah kesalahan -- silahkan buka kembali tiket dan sediakan informasi lebih lanjut. Kembali, mohon jangan dibuka kembali tiket yang telah ditandai sebagai "wontfix" dan membawa masalah ke django-developers sebagai gantinya.

Bagaimana saya dapat membantu dengan penyortiran?

Pengolahan penyortiran adalah utamanya dikendalikan oleh anggota komunitas. Benar, SIAPAPUN dapat membantu.

Untuk ikut serta, mulai dengan membuat sebuah akun pada Trac. Jika anda mempunyai sebuah akun tetapi lupa sandi anda, anda dapat menyetel kembali menggunakan password reset page.

lalu, anda dapat membantu dengan:

• Menutup tiket "Unreviewed" sebagai "invalid", "worksforme", atau "duplicate", atau "wontfix".
• Menutup tiket "Unreviewed" sebagai "needsinfo" ketika gambaran terlalu jarang menjadi ditindaklanjuti, atau ketika mereka sedang meminta fitur membutuhkan obrolan pada django-developers.
• Memperbaiki bendera "Butuh percobaan", "Butuh dokumentasi", atau "Mempunyai tambalan" untuk tiket dimana mereka disetel tidak benar.
• Mengatur bendera "Easy pickings" untuk tiket yang kecil dan relatif mudah.
• Setel jenis dari tiket yang masih belum dikelompokkan.
• Memeriksa tiket lama itu masih sah. Jika sebuah tiket tidak kelihatan aktifitas apapun dalam jangka lama, itu dimungkinkan bahwa masalah telah diperbaiki tetapi tiket belum ditutup.
• Kenali gaya dan tema dalam tiket. Jika ada banyak laporan kesalahan tentang bagian tertentu dari Django, itu mungkin menandakan kami harus mempertimbangkan refaktorisasi bagian itu dari kode. Jika sebuah gaya muncul, anda harus menampilkannya untuk obrolan (mengacu tiket yang sesuai) pada django-developers.
• Periksa jika tambalan diajukan oleh pengguna lain adalah benar. Jika mereka benar dan juga mengandung dokumentasi dan percobaan yang sesuai kemudian pindahkan mereka ke tahapan "Siap untuk Pendaftaran". Jika mereka tidak benar lalu tinggalkan sebuah komentar untuk menjelaskan mengapa dan setel bendera sesuai ("Tambalan butuh perbaikan", "Butuh percobaan" dll.).

Catatan

Reports page mengandung tautan ke banyak permintaan Trac berguna, termasuk beberapa yang berguna untuk memberikan tiket dan meninjau tambalan sebagai disarankan diatas.

Anda dapa juga menemukan lebih Saran untuk penyumbang baru.

Bagaimanapun, kami meminta berikut semua anggota komunitas umum yang bekerja di basisdata tiket:

• Mohon jangan mengenalkan tiket anda sendiri ke "Siap untuk Pendaftaran". Anda mungkin menandai tiket orang lain yang anda telah tinjau sebagai "Siap untuk Pendaftaran", tetapi anda harus mendapatkan minimal satu anggota komunitas lain untuk meninjau sebuah tambalan yang anda ajukan.
• Harap jangan membalikkan sebuah keputusan tanpa menempatkan sebuah pesan pada django-developers untuk menemukan pemufakatan.
• Jika anda tidak yakin jika anda harus membuat sebuah perubahan, jangan membuat perubahan tetapi lebih baik tinggalkan sebuah komentar dengan perhatian anda pada tiket, atau tempatkan sebuah pesan ke django-developers. Tidak apa-apa untuk tidak yakin, tetapi masukan anda masih berharga.

Membagi dua pemulihan

Pemulihan adalah sebuah kesalahan yang hadir dalam beberapa versi terbaru dari Django tetapi tidak di versi lama. Sepotong informasi sangat membantu adalah perbaikan yang memperkenalkan pemulihan. Sepengetahuan penyerahan yang menyebabkan perubahan dalam kebiasaan membantu mencirikan jika perubahan disengaja atau jika itu efek samping tidak sengaja. Disini bagaimana anda dapat menentukan ini.

Begin by writing a regression test for Django's test suite for the issue. For example, we'll pretend we're debugging a regression in migrations. After you've written the test and confirmed that it fails on the latest main branch, put it in a separate file that you can run standalone. For our example, we'll pretend we created tests/migrations/test_regression.py, which can be run with:

$ ./runtests.py migrations.test_regression

Selanjutnya, kami menandai titik saat ini dalam sejarah menjadi "buruk" sejak kegagalan percobaan:

$ git bisect bad
You need to start by "git bisect start"
Do you want me to do it for you [Y/n]? y

Sekarang, kami butuh menemukan titi dalam sejarah git sebelum pemulihan diperkenalkan (yaitu sebuah titik dimana percobaan lulus). Gunakan sesuatu seperti git checkout HEAD~100 untuk memeriksa pembetulan awal (100 perbaikan awal, dalam kasus ini). Periksa jika percobaan gagal. Jika demikian, tandai titik itu sebagai "buruk" (git bisect bad), lalu periksa pembetulan awal dan periksa kembali. Sekali anda menemukan pembetulan dimana percobaan anda lulus, tandai itu sebagai "bagus":

$ git bisect good
Bisecting: X revisions left to test after this (roughly Y steps)
...

Sekarang kami siap untuk bagian menariknya: menggunakan git bisect run untuk mengotomatis sisa dari pengolahan:

$ git bisect run tests/runtests.py migrations.test_regression

Anda seharusnya melihat git bisect menggunakan pencarian biner untuk otomatis periksa perbaikan diantara perbaikan baik dan buruk sampai dia menemukan perbaikan "buruk" dimana percobaan gagal.

Sekarang, laporkan hasil anda di tiket Trac, dan silahkan sertakan percobaan pemulihan sebagai sebuah lampiran. Ketika seseorang menulis perbaikan untuk kesalahan, mereka sudah akan memiliki percobaan anda sebagai sebuah titik permulaan.