.github/ISSUE_TEMPLATE/, pake fitur issue forms GitHub. Repo docs belum punya issue form sendiri - buka issue polos di situ, atau pake salah satu form repo contoh kalau bug-nya beneran soal contoh tertentu.
Tiga form
Bug report
Buat apa pun yang rusak atau kelakuannya beda dari yang dikata-in docs. Form-nya nanya:- Contoh dan bahasa mana (form Pulumi punya dropdown untuk enam bahasa)
- Versi tool yang persis, kayak versi Terraform atau
pulumi - Langkah-langkah berurutan buat reproduce
- Expected behavior versus behavior aslinya, dengan output error lengkap yang di-paste
Feature request
Buat contoh baru, pattern bahasa baru, atau improvement. Form-nya nanya masalahnya dulu, terus proposal, terus alternatif yang udah lu coba. Struktur masalah-dulu ada karena feature request terbaik itu deskripsi tentang sesuatu yang gak bisa lu lakuin; proposal boleh berubah pas review, masalahnya gak.Docs improvement
Buat komentar dan README yang salah, gak jelas, atau hilang. Bug docs itu bug beneran di sini: inti dari repo contoh itu ngajar, jadi komentar yang bikin bingung itu cacat, bukan sekadar hiasan. Form-nya nanya file dan section-nya, baris persis yang salah, dan usulan tulis ulang.Kapan pake Issue, kapan pake Discussions
Pake GitHub Discussions di repo daripada issue kalau:- Lu punya pertanyaan soal gimana sesuatu jalan
- Lu mau share apa yang udah lu bangun pake contoh-contohnya
- Lu mau diskusiin ide sebelum ngusulin
- Sesuatu gak rusak, cuma bikin lu kaget
Label
Form issue nge-assign satu label per jenis:bug, enhancement, atau documentation. Selain itu, set minimal bikin triage tetap simpel:
Maintainer nambahin tiga label terakhir pas triage. Gak ada service level agreement soal waktu respons; ini project komunitas, dan issue dapet perhatian sesuai urutan masuknya. Issue yang lengkap dengan langkah reproduce bergerak paling cepet karena paling dikit butuh pertanyaan susulan.
Nulis issue yang cepet ke-fix
- Search dulu, baik issue yang masih open maupun yang udah closed, plus Discussions. Keanehan GPU keypair, contohnya, udah di-dokumentasiin di the Pulumi GPU reference dan di komentar kode contoh.
- Satu issue per masalah. Dua bug dalam satu issue artinya salah satunya bakal nyasar.
- Isi tiap field yang form-nya kasih. Form-nya didesain buat nangkep apa yang maintainer butuhin.
- Paste output error yang lengkap, bukan paraphrase. Error berisi nama resource dan attribute yang gagal.
- Kata-in apa yang lu harapin dan apa yang lu dapet, dengan kata-kata itu.
- Jangan pernah taruh secret di issue. Redact token dan password; output contoh-contohnya termasuk private key dan secret key, dan nge-paste itu artinya harus rotate semuanya.
Triage, dari sisi maintainer
Issue baru melewati tiga pertanyaan: ini bug provider, bug contoh, atau bug docs? Jawabannya nentuin repo-nya:- Bug provider: dipindah ke terraform-provider-biznetgio atau pulumi-biznetgio, terus contoh dan docs di-update biar nyamain behavior asli provider setelah ke-fix.
- Bug contoh: di-fix di repo contoh, dicerminkan ke semua bahasa, docs di-update di PR yang sama atau PR terhubung.
- Bug docs: di-fix dalam dua bahasa di repo docs.