Bekerja dengan Git dan GitHub

Bagian ini menjelaskan bagaimana komunitas dapat membantu kode pada Django melalui pull request. Jika anda tertarik dalam bagaimana pembuat perbaikan menangani mereka, lihat Memperbaiki kode.

Dibawah ini, kami akan menunjukkan bagaimana membuat pull request GitHub mengandung perubahan untuk tiket Trac #xxxxx. Dengan membuat pull request sepenuhnya siap, anda akan membuat pekerjaan peninjau lebih mudah, berarti bahwa pekerjaan anda lebih mungkin digabungkan kedalam Django.

Anda dapat juga menunggah tambalan tradisional ke Trac, tetapi dia kurang praktis untuk peninjauan.

Memasang Git

Django menggunakan Git untuk kendali sumbernya. Anda dapat mengunduh Git download, tetapi itu terkadang lebih mudah memasang dengan pengelola paket sistem operasi anda.

Git repository Django disimpan di GitHub, dan itu dianjurkan bahwa anda juga bekerja menggunakan GitHub.

Setelah memasang Git, hal pertama anda harus lakukan adalah mengatur nama dan surel anda:

$ git config --global user.name "Your Real Name"
$ git config --global user.email "[e-mail]"

Catat bahwa user.name harus nama asli anda, bukan nama pendek GitHub. GitHub harus tahu surel anda gunakan di bidang user.email, karena ini akan digunakan untuk menghubungkan perbaikan anda ke akun GitHub anda.

Mengatur gudang lokal

Ketika anda telah membuat akun GitHub anda, dengan nama pendek "GitHub_nick" dan forked Django's repository, buat salinan lokal dari fork anda:

git clone https://github.com/GitHub_nick/django.git

Ini akan membuat pelipat baru "django", mengandung kloning dari gudang GitHub anda. Sisa dari perintah git pada halaman ini butuh dijalankan dalam pelipat kloning, jadi ganti ke itu sekarang:

cd django

Gudang GitHub anda akan dipanggil "origin" dalam Git.

Anda harus juga mengatur django/django sebagai sebuah terpencil "hulu" (yaitu, memberitahu git bahwa acuan gudang Django adalah sumber dari fork anda darinya):

git remote add upstream [e-mail]:django/django.git
git fetch upstream

Anda dapat juga menambahkan terpencil lainnya dengan cara yang sama, sebagai contoh:

git remote add akaariai [e-mail]:akaariai/django.git

Bekerja pada tiket

Ketika bekerja pada sebuah tket, buat cabang baru untuk pekerjaan, dan dasarkan pekerjaan itu pada upstream/master:

git checkout -b ticket_xxxxx upstream/master

Bendera -b membuat cabang baru untuk anda secara lokal. Jangan ragu-ragu membuat cabang-cabang baru bahkan untu hal-hal terkecil - itulah apa mereka ada.

Jika malahan anda sedang bekerja untuk perbaikan pada cabang 1.4, anda akan melakukan:

git checkout -b ticket_xxxxx_1_4 upstream/stable/1.4.x

Anggap pekerjaan dibawah pada cabang ticket_xxxxx. Buat beberapa perubahan dan perbaiki mereka:

git commit

Ketika menulis pesan perbaikan, ikuti commit message guidelines untuk mempermudah pekerjaan dari pembuat perbaikan. Jika anda tidak nyaman dengan Inggris, coba setidaknya gambarkan secara tepat apa yang perbaikan lakukan.

Jika anda butuh melakukan tambahan pekerjaan pada cabang anda, perbaikan sesering yang diperlukan:

git commit -m 'Added two more tests for edge cases'

Menerbitkan pekerjaan

Anda dapat menerbitkan pekerjaan anda pada GitHub dengan menjalankan:

git push origin ticket_xxxxx

Ketika anda pergi ke halaman GitHub, anda akan melihat cabang baru telah dibuat.

Jika anda sedang bekerja pada tiket Trac, anda harus menyebutkan dalam tiket yang pekerjaan anda tersedia dari cabang ticket_xxxxx dari gudang GitHub. Sertakan sebuah tautan pada cabang anda.

Catat bahwa cabang diatas dipanggil "topic branch" di bahasa Git. Anda bebas menulis kembali riwayat dari cabang ini, dengan menggunakan git rebase sebagai contoh. Orang lain tidak harus dasarkan pekerjaan mereka pada cabang seperti itu, karena kloningan mereka akan menjadi rusak ketika anda menyunting perbaikan.

Ada juga "cabang umum". Ini adalah cabang-cabang orang lain seharusnya untuk menyalin gudang kode, jadi riwayat dari cabang-cabang ini harus tidak pernah berubah. Contoh baik dari cabang umum adalah cabang master dan stable/A.B.x di gudang django/django`.

Ketika anda berpikir pekerjaan anda siap untuk ditarik ke Django, anda harus membuat sebuah pull request pada GitHub. Pull request baik artinya:

• perbaiki dengan satu perubahan logika di setiapnya, mengikuti coding style,
• Pesan-pesan berbentuk baik untuk setiap perbaikan: sebuah baris ringkasan dan kemudian paragraf dibungkus pada 72 karakter setelah itu -- lihat committing guidelines untuk lebih rinci,
• dokumentasi dan percobaan, jika dibutuhkan -- percobaan sebenarnya selalu dibutuhkan, kecuali untuk perubahan dokumentasi.

Rangkaian percobaan harus dilewati dan dokumentasi harus dibangun tanpa peringatan.

Sekali anda telah membuat pull request anda, anda harus menambahkan sebuah komentar di tiket Trac terkait menjelaskan apa yang telah anda lakukan. Khususnya, anda harus catat lingkungan dimana anda menjalankan percobaan, sebagai contoh: "semua percobaan lolos dibawah SQLite dan MySQL".

Pull requests at GitHub have only two states: open and closed. The committer who will deal with your pull request has only two options: merge it or close it. For this reason, it isn't useful to make a pull request until the code is ready for merging -- or sufficiently close that a committer will finish it themselves.

Rebase cabang-cabang

Di contoh diatas, anda membuat dua perbaikan, perbaikan "Fixed ticket_xxxxx" dan perbaikan "Added two more tests".

Kami tidak ingin memiliki seluruh riwayat dari pengolahan pekerjaan anda di gudang anda. Perbaikan anda "Added two more tests" akan menjadi kebisingan yang tidak membantu. Malahan, kami bukan hanya mempunyai satu perbaikan mengandung semua pekerjaan anda.

Untuk bekerja kembali riwayat dari cabang anda anda dapat melumatkan perbaikan kedalam satu dengan menggunakan rebase interaktif:

git rebase -i HEAD~2

HEAD~2 diatas adalah tangan cepat untuk dua perbaikan terakhir. Perintah diatas akan membuka sebuah penyunting menunjukkan dua perbaikan, diawali dengan kata "pick".

Rubah "pick" pada baris kedua pada "squash" sebagai gantinya. Ini akan menjaga perbaikan pertama, dan melumat perbaikan kedua kedalam yang pertama. Simpan dan hemtikan penyunting. Jendela penyunting kedua harus terbuka, jadi anda dapat menaruh kata lain pesan perbaikan untuk perbaikan sekarang dimana dia menyertakan kedua langkah-langkah anda.

Anda dapat juga menggunakan pilihan "edit" di rebase. Cara ini anda dapat merubah perbaikan tunggal, sebagai contoh untuk memperbaiki salah ketik dalam docstring:

git rebase -i HEAD~3
# Choose edit, pick, pick for the commits
# Now you are able to rework the commit (use git add normally to add changes)
# When finished, commit work with "--amend" and continue
git commit --amend
# Reword the commit message if needed
git rebase --continue
# The second and third commits should be applied.

Jika topik cabang anda sudah diterbitkan pada GitHub, sebagai contoh jika anda sedang membuat perubahan kecil untuk diambil ke tinjauan akun, anda akan butuh mendorong-paksa perubahan:

git push -f origin ticket_xxxxx

Catat bahwa ini akan menulis kembali riwayat dari ticket_xxxxx - jika anda memeriksa campuran commit sebelum dan sesudah tindakan pada GitHub anda akan menyadari bahwa campuran commit tidak cocok lagi. Ini dapat diterima, ketika cabang adalah cabang topik, dan tidak seorangpun harus mendasarkan pekerjaannya pada itu.

Setelah upstream telah berubah

Ketika hulu (django/django) telah berubah, anda harus rebase pekerjaan anda. Untuk melakukan ini, gunakan:

git fetch upstream
git rebase

Pekerjaan otomatis di rebase menggunakan cabang anda cabangkan, di contoh kasus menggunakan upstream/master.

Perintah rebase memindahkan semua perbaikan lokal sementara, berlakukan perbaikan upstream, dan kemudian berlakukan perbaikan lokal anda pada pekerjaan.

Jika ada pertentangan penggabungan, anda akan butuh menyelesaikan mereka dan kemudian menggunakan git rebase --continue. Pada tiap titik anda dapat menggunakan git rebase --abort untuk mengembalikan ke keadaan asli.

Catat bahwa anda ingin rebase pada upstream, bukan merge upstream.

Alasan untuk ini adalah dengan rebase, perbaikan anda akan selalu on top of pekerjaan upstream, bukan mixed in with perubahan di upstream. Cara ini cabang anda akan mengandung hanya perbaikan terhubung pada topiknya, yang membuat pelumatan lebiih mudah.

Setelah meninjau

Itu tidak biasa mendapatkan setiap jumlah bukan sepele dari kode kedalam inti tanpa perubahan diminta oleh peninjau. Di kasus ini, itu adalah sering ide bagus untuk menambahkan perubahan sebagai perbaikan menaik pada pekerjaan anda. Ini mengizinkan peninjau dengan mudah memeriksa perubahan apa anda telah lakukan.

Dalam kasus ini, melakukan perubahan diwajibkan oleh peninjau. Perbaikan sesering kebutuhan. Sebelum menerbitkan perubahan, bangun tingkatan baru pekerjaan anda. Jika anda menambahkan dua perbaikan, anda harus menjalankan:

git rebase -i HEAD~2

Lumatkan perbaikan kedua kedalam yang pertama. Tulis sebuah pesan perbaikan bersama baris:

Made changes asked in review by <reviewer>

- Fixed whitespace errors in foobar
- Reworded the docstring of bar()

Akhirnya, kirim kerjaan anda kembali ke gudang GitHub. Sejak anda tidak menyentuk perbaikan umum selama tingkatan dasar baru, anda tidak butuh untuk paksa-kirim:

git push origin ticket_xxxxx

Pull request anda sekarang harus mengandung perbaikan baru juga.

Catat bahwa pembuat perbaikan kemungkinan melumat tinjauan perbaikan kedalam perbaikan sebelumnya ketika memperbaiki kode.

Bekerja pada tambalan

Satu cara bahwa pengembang dapat menyumbang ke Django adalah dengan meninjau tambalan-tambalan. Tambalan-tambalan tersebut khususnya ada sebagai pull request pada GitHub dan dapat dengan mudah dipadukan ke dalam gudang lokal anda:

git checkout -b pull_xxxxx upstream/master
curl https://github.com/django/django/pull/xxxxx.patch | git am

Ini akan membuat cabang baru dan kemudian memberlakukan perubahan dari pull request ke itu. Pada titik ini anda dapat menjalankan percobaan atau melakukan apapun lainnya anda butuhkan untuk menyelidiki kualitas tambalan.

Untuk lebih rinci pada bekerja dengan pull request lihat guidelines for committers.

Ringkasan

• Bekerja pada GitHub jika anda bisa.
• Umumkan pekerjaan anda di tiket Trac dengan menautkan ke cabang GitHub anda.
• Ketika anda mempunyai sesuatu yang siap, buat pull request.
• Buat pull request sebaik anda bisa.
• Ketika melakukan perbaikan ke pekerjaan anda, gunakan git rebase -i untuk melumat perbaikan.
• Ketika upstream telah dirubah, lakukan git fetch upstream; git rebase.