Bagikan melalui

Berkontribusi pada dokumentasi PowerShell

Terima kasih atas dukungan Anda terhadap PowerShell!

Panduan Kontributor adalah kumpulan artikel yang menjelaskan alat dan proses yang kami gunakan untuk membuat dokumentasi di Microsoft. Beberapa panduan ini mencakup informasi umum untuk kumpulan dokumentasi apa pun yang diterbitkan ke learn.microsoft.com. Panduan lain khusus untuk cara kami menulis dokumentasi untuk PowerShell.

Artikel umum tersedia di Panduan Kontributor terpusat kami. Panduan khusus PowerShell tersedia di sini.

Cara untuk berkontribusi

Ada dua cara untuk berkontribusi. Kedua kontribusi sangat berharga bagi kami.

  • Masalah pengarsipan membantu kami mengidentifikasi masalah dan kesenjangan dalam dokumentasi kami. Terkadang masalah sulit diselesaikan, membutuhkan lebih banyak penyelidikan dan penelitian. Proses masalah memungkinkan kami untuk memiliki percakapan tentang masalah dan mengembangkan resolusi yang memuaskan.

  • Mengirimkan permintaan pull untuk menambahkan atau mengubah konten adalah proses yang lebih terlibat. Informasi berikut menguraikan alat, proses, dan standar untuk mengirimkan konten ke dokumentasi.

Bersiap untuk membuat kontribusi

Berkontribusi pada dokumentasi memerlukan akun GitHub. Gunakan daftar periksa berikut untuk menginstal dan mengonfigurasi alat yang Anda butuhkan untuk membuat kontribusi.

  1. Mendaftar untuk GitHub
  2. Menginstal alat Git dan Markdown
  3. Menginstal Paket Penulisan Dokumen
  4. Instal Posh-Git - tidak diperlukan tetapi disarankan
  5. Menyiapkan repositori Git lokal
  6. Tinjau dasar-dasar Git dan GitHub

Mulai menulis dokumen

Ada dua cara untuk menyumbangkan perubahan pada dokumentasi:

  1. Pengeditan cepat ke dokumen yang ada - Koreksi kecil, memperbaiki kesalahan ketik, atau penambahan kecil
  2. Alur kerja GitHub penuh untuk dokumen - perubahan besar, beberapa versi, menambahkan atau mengubah gambar, atau berkontribusi artikel baru

Baca juga bagian Dasar-dasar Penulisan dari Panduan Terpusat untuk Kontributor. Sumber daya luar biasa lainnya adalah Panduan Gaya Penulisan Microsoft.

Koreksi atau klarifikasi kecil terhadap contoh dokumentasi dan kode di repositori publik dicakup oleh Ketentuan Penggunaan learn.microsoft.com.

Gunakan alur kerja GitHub lengkap saat Anda membuat perubahan signifikan. Jika Anda bukan karyawan Microsoft, sistem validasi PR kami menambahkan komentar ke permintaan pull yang meminta Anda untuk menandatangani Perjanjian Lisensi Kontribusi (CLA) online. Anda harus menyelesaikan langkah ini sebelum kami dapat meninjau atau menerima permintaan pull Anda. Menandatangani CLA hanya diperlukan saat pertama kali Anda mengirimkan PR di repositori. Anda mungkin diminta untuk menandatangani CLA setiap kali Anda berkontribusi ke repositori baru.

Tata Tertib

Semua repositori yang menerbitkan ke Microsoft Learn mematuhi Kode Etik Sumber Terbuka Microsoft atau Kode Etik .NET Foundation. Untuk informasi selengkapnya, lihat Tanya Jawab Umum Kode Etik.

Langkah berikutnya

Artikel berikut ini mencakup informasi khusus untuk dokumentasi PowerShell. Jika ada tumpang tindih dengan panduan dalam Panduan Kontributor terpusat, kami menyebutkan bagaimana aturan tersebut berbeda untuk konten PowerShell.

Tinjau dokumen berikut:

Sumber daya tambahan

  • Last updated on