Pengantar dan Tujuan¶

Apa itu Panduan Kontributor?¶

Pertama, penting untuk dicatat bahwa kita tidak hanya berbicara tentang proyek kode. Kontribusi OpenStack datang dalam berbagai bentuk seperti menjalankan pertemuan, mengidentifikasi kasus penggunaan (Product Working Group), dokumentasi, pengujian, dll. Tujuan kami adalah agar kontribusi ini dihargai sama.

Panduan Kontributor bertujuan untuk menyediakan dokumentasi umum untuk semua Kontributor OpenStack dan membantu upaya on-boarding.

Memiliki dokumentasi umum yang dikerjakan oleh berbagai proyek akan lebih baik membantu mencegah upaya duplikasi, dokumentasi tidak konsisten, dan juga akan memberikan informasi yang lebih akurat. Proyek yang memiliki dokumentasi zero/outdated juga dapat menggunakan Panduan Kontributor.

Di mana Panduan Ini Digunakan¶

Di berbagai acara OpenStack, Panduan Kontributor digunakan untuk membantu berbagai program on-boarding:

The OpenStack Upstream Institute
The Certified OpenStack Administrator Exam
Sesi on-boarding tim proyek

Panduan Kontributor Khusus Proyek¶

Tim proyek masih harus memiliki dokumentasi kontributor mereka sendiri untuk mencakup hal-hal yang tercantum di bawah Examples of Documentation that's NOT Common. Beberapa contoh panduan kontributor khusus tim proyek adalah Nova team's dan Documentation team's.

Menambah / Memperbarui Konten¶

Sebelum Anda memodifikasi atau menambahkan konten baru, kenali dulu praktik kode / dokumentasi OpenStack. Anda dapat membaca Code & Documentation Contributor Guide untuk memulai.

Setelah Anda membaca panduan ini, gunakan git untuk mengkloning repositori Panduan Kontributor

git clone https://opendev.org/openstack/contributor-guide

Pedoman Konten¶

Tidak ada dinding teks (No wall of text). Pembaca harus merasa bahwa mereka dapat menyelesaikan hal-hal di halaman dalam lima menit, alih-alih memiliki tab lain yang lupa bahwa mereka tidak akan pernah kembali.
Gunakan screen shot.
Hindari membahas setiap masalah yang bisa kena sepanjang jalan. Kasus per kasus akan diterima tergantung pada seberapa umum itu.
Tidak ada video. Mereka terlalu rumit untuk terus diperbarui.

Hanya Konten Umum¶

Karena Panduan Kontributor dimaksudkan bersifat umum sehingga semua orang dapat menggunakannya, berikut adalah beberapa contoh bermanfaat tentang apa yang harus dikontribusikan. Contoh hal yang ** not ** umum harus ada dalam dokumentasi spesifik tim proyek Anda yang akan dicantumkan di Portal Kontributor.

Contoh Dokumentasi Umum¶

Menyiapkan Git.
Menyiapkan IRC untuk berkomunikasi.
Menyiapkan Milis untuk berkomunikasi.
Menyiapkan akun yang tepat untuk berkontribusi seperti Gerrit, Storyboard, dan Launchpad.
Cara memilih dalam pemilihan.

Contoh Dokumentasi yang TIDAK Umum¶

Beberapa alat perangkat lunak khusus yang hanya digunakan oleh tim proyek Anda.
Prosedur khusus untuk melakukan hal seperti bug triase.

Contoh Dokumentasi yang Baik¶

Gunakan bab yang telah diterima untuk merasakan apa yang kita cari.

Bagaimana Saya Mulai Membantu?¶

Laporan dan tugas bug semuanya dicatat dalam Storyboard. Jika sesuatu tidak ditugaskan, tersedia untuk Anda ambil.

Dapatkan Bantuan Berkontribusi¶

We want you to succeed! You can ask for help on IRC OFTC in channel #openstack-doc. You can also ask for help on the OpenStack Discuss Mailing list prefixing your email subject with '[contributor-guide]'. If you're not familiar with these ways of communicating, read the Code & Documentation Contributor Guide.

Pengantar dan Tujuan