Dalam proyek ini, kita memaksimalkan penggunaan fitur-fitur GitHub untuk mendokumentasikan dan memberikan sinyal terhadap kemajuan apapun dalam pengerjaan website ini.
Sebagian besar kontribusi berawal dari membuat Issues. Tiap orang dapat memulai membuat Issues untuk diskusi. Anda dapat mengunjungi pranala ini untuk pemahaman lebih lanjut mengenai Issues. Secara spesifik, Anda dapat menemukan Issues di tab Issues ini. Hanya ada dua kategori bagian pada Issues, yakni Open dan Closed Issues.
Open Issues merupakan kategori yang membutuhkan perhatian lebih serta penyelesaian. Kontributor disarankan menelusuri bagian Open Issues dan mulai mengerjakannya.
Closed Issues merupakan kategori issue yang sudah selesai dikerjakan atau tidak membutuhkan aksi lanjutan. Issue dengan status closed dapat kembali diubah menjadi open ketika kontibutor menemukan issue yang berhubungan di masa mendatang.
Mohon perhatikan tiap atribut issue. Tiap issue kemungkinan dikerjakan oleh kontributor lain melalui Linked Pull Requests. Ini berarti issue sedang dalam penanganan. Untuk menghindari pekerjaan yang sama, kontributor sangat dianjurkan untuk mengajukan sebuah draft pull request terlebih dahulu setiap kali hendak mengerjakan suatu issue.
Seperti yang tertulis di sini, good first issue merupakan sebuah fitur label dari GitHub yang diciptakan untuk membantu para kontributor pemula dalam berkontribusi ke sebuah proyek open-source. good first issue memberitakan kita mengenai tingkat kesulitan dari sebuah issue. Ini berarti, bahwa sebuah issue dengan label good first issue cocok sekali bagi kontributor pemula yang ingin melakukan kontribusi pertama mereka ke sebuah proyek open-source.
Bagaimana cara mencari issue dengan label good first issue:
- Cara paling mudah adalah dengan mengunjungi pranala
github.com/<owner>/<repository>/contribute. Dalam hal ini, Anda dapat mengunjungi pranala ini. Pranala tersebut akan memberikan daftar dari semua issue dengan labelgood first issue. - Atau cara lainnya adalah dengan mengunjungi bagian Issues dari sebuah repository, lalu klik bagian Labels di sebelah Milestones. Di sana, Anda dapat melihat banyak label untuk issues yang terdapat dalam repository tersebut. Lalu cari dan klik label
good first issue.
Sebelum mengerjakan sebuah issue, ada hal yang harus diperhatikan:
- Apakah ada kontributor lain yang sedang mengerjakannya? Anda dapat mencari apakah ada pull request terkait sebelum memutuskan untuk mulai mengerjakan issue tersebut.
- Untuk mulai mengerjakannya, pastikan create branch dari
main, lalu segera commit dan push perubahannya sesegera mungkin sekecil apapun itu. - Kemudian buat pull request baru dengan menjadikannya sebagai draft pull request untuk memberikan sinyal kepada kontributor lainnya bahwa pull request ini masih sedang dalam pengerjaan. Dengan demikian, orang lain yang ingin mengerjakan issue yang sama akan berpikir dua kali sebelum ikut mengerjakannya.
Draft Pull Requests merupakan sebuah fitur yang disediakan oleh GitHub, yang bertujuan sebagai alat berkomunikasi bagi para kontributor. Ketika kita membuat sebuah Draft Pull Request, kita tidak bisa menggabungkannya melainkan kita sudah menandainya sebagai Ready for review. Ini merupakan pendekatan yang lebih baik untuk menggunakannya sebagai alat berkomunikasi antar kontributor, dan kita juga bisa memberikan informasi bahwa kita sedang mengatasi sebuah isu.
Langkah-langkah untuk membuat Draft Pull Request:
-
Commit dan push perubahan terbaru ke forked repository Anda.
-
Pergi ke bagian Pull requests pada forked repository Anda, dan klik New pull request.
-
Pilih forked repository Anda sebagai head repository, dan pilih branch tempat Anda membuat perubahan untuk bagian compare.
-
Berikan sebuah judul dan beberapa deskripsi mengenai pull request Anda, lalu pilih Create draft pull request (seperti pada gambar di bawah) dan klik tombol berwarna hijau.
-
Jangan lupa untuk menandai Draft Pull Request Anda sebagai Ready for review ketika Anda sudah melakukan semua perubahan yang diinginkan.
Ada beberapa alasan mengapa kita menggunakan bahasa Inggris ketika berkomunikasi di dalam issue dan pull request:
- Secara alamiah, lebih mudah untuk software engineer berkomunikasi dalam bahasa Inggris, karena terminologi-terminologi teknis yang digunakan dalam pemrograman pun berbahasa Inggris. Menerjemahkannya ke Bahasa Indonesia memunculkan resiko miskomunikasi, sementara menggunakan Bahasa Inggris membutuhkan banyak penyesuaian penulisan dalam bentuk italic mengacu pada PUEBI.
- Membiasakan para kontributor yang mayoritas berasal dari Indonesia untuk berkomunikasi dengan bahasa Inggris. Sangat penting untuk mengasah kemampuan menulis dan membaca bahasa Inggris kita karena sebagian besar dari komunitas open-source di seluruh dunia menggunakan bahasa Inggris sebagai bahasa utama mereka.
- Menggunakan bahasa Inggris membuat proyek ini lebih mudah diakui secara global. Apabila kita ingin mendapatkan dukungan dari komunitas global, mereka lebih mudah memahami tujuan kita, sehingga mereka lebih mudah untuk meluangkan waktu dan keahlian mereka untuk membantu membuat proyek ini lebih baik. Contohnya menyediakan free credits untuk layanan mereka, mengadvokasikan proyek ini kepada pemimpin dunia, atau berkontribusi langsung ke proyek kita.
Issue labels adalah fitur untuk mengelompokkan beberapa issues ke dalam satu atau banyak kategori berbeda. Hal ini memudahkan kita untuk memantau serta mengelola issues dan pull requests yang ada pada repository WargaBantuWarga.
Jika Anda memiliki ide atau saran untuk penambahan label baru yang belum ada di repository, mohon untuk membuka issue di kawalcovid19/wargabantuwarga.com.
| Nama label | /wargabantuwarga.com |
Deskripsi |
|---|---|---|
blocked |
cari | Issues yang terhalang oleh issue lainnya. |
bug |
cari | Laporan mengenai adanya bug atau kesalahan pada website. |
enhancement |
cari | Permintaan untuk penambahan fitur baru. |
epic |
cari | Utas utama dari issue yang didalamnya terdiri dari beberapa issues yang lebih sederhana. |
good first issue |
cari | Issues yang sederhana. Cocok untuk para pemula untuk mulai berkontribusi ke repository WargaBantuWarga. |
help wanted |
cari | Issues yang membutuhkan perhatian lebih dan prioritas. |
invalid |
cari | Issues yang tidak valid. |
question |
cari | Membutuhkan informasi tambahan terkait permasalahan yang ada atau terkait permintaan fitur baru. |
wontfix |
cari | Tim WargaBantuWarga tidak akan mengerjakan issue tersebut untuk saat ini. |
| Nama Label | /wargabantuwarga.com |
Deskripsi |
|---|---|---|
ci-cd |
cari | Continuous Integration & Continuous Delivery. |
design |
cari | Issues yang berkaitan dengan desain. |
documentation |
cari | Perbaikan serta penambahan informasi pada dokumentasi. |
dx |
cari | Issues terkait pengalaman developer dalam melakukan pengembangan. |
ui |
cari | Issues terkait tampilan antar muka pengguna. |
ux |
cari | Issues terkait pengalam pengguna dalam menggunakan website. |
seo |
cari | Search engine optimization. |
scripting |
cari | Issues terkait kode. |
testing |
cari | Automated testing. |
netlify-cms/draft |
cari | Draft perubahan konten di Netlify CMS. |
netlify-cms/pending_publish |
cari | Perubahan koten siap untuk dipublikasikan melalui Netlify CMS. |
netlify-cms/pending_review |
cari | Perubahan konten sedang dalam peninjauan di Netlify CMS. |