Bagikan melalui

Mengelola permintaan pull

Artikel ini mencakup cara kami mengelola permintaan pull di repositori PowerShell-Docs. Artikel ini dirancang untuk menjadi bantuan pekerjaan bagi anggota tim PowerShell-Docs. Kami menerbitkan informasi ini di sini untuk memberikan transparansi proses bagi kontributor publik kami.

Praktik terbaik

  • Minta peninjauan. Orang yang mengirimkan PR tidak boleh menggabungkan PR tanpa tinjauan rekan sejawat.
  • Tetapkan peninjau rekan ketika PR dikirimkan. Penugasan awal memungkinkan peninjau merespons lebih cepat dengan komentar editorial.
  • Gunakan komentar untuk menjelaskan sifat perubahan yang dikirimkan. Misalnya, jika perubahannya kecil, jelaskan perubahan dan Anda tidak memerlukan tinjauan teknis lengkap. Pastikan untuk melakukan @mention kepada peninjau.
  • Gunakan fitur saran komentar untuk memudahkan penulis menerima perubahan yang disarankan. Untuk informasi selengkapnya, lihat Meninjau perubahan yang diusulkan dalam permintaan pull.

Langkah-langkah Proses PR

  1. Penulis: Buat PR
    • Isi templat PR
    • Hubungkan masalah apa pun yang diselesaikan oleh PR
    • Gunakan fitur autoclose GitHub untuk menutup masalah
    • Bekerja melalui dan mencentang setiap item dalam daftar periksa
  2. Penulis: Menetapkan peninjau serekan
  3. Peninjau: memeriksa dan memberikan komentar (seperlunya)
  4. Penulis: Menggabungkan umpan balik ulasan
  5. Keduanya: Meninjau penyajian pratinjau
  6. Keduanya: Meninjau laporan validasi - memperbaiki peringatan dan kesalahan
  7. Peninjau: Tandai ulasan "Disetujui"
  8. Repo Maintainer: Gabungkan PR

Daftar Periksa Peninjau Isi

Lihat daftar periksa editorial untuk daftar yang lebih komprehensif.

  • Memeriksa tata bahasa, gaya, keringkasan, dan akurasi teknis
  • Pastikan contoh masih berlaku untuk versi target
  • Cek Penampilan Pratinjau
  • Periksa metadata - ms.date, hapus ms.assetid, pastikan bidang yang diperlukan
  • Memvalidasi kebenaran markdown
    • Lihat panduan gaya untuk aturan pemformatan khusus konten
  • Susun ulang contoh sebagai berikut:
    • Paragraf Pengantar
    • Kode dan output
    • Penjelasan terperinci tentang kode (seperlunya)
  • Periksa hyperlink untuk akurasi
    • Mengganti atau menghapus tautan TechNet/MSDN
    • Pastikan pengalihan seminimal mungkin ke target
    • Pastikan HTTPS
    • Jenis tautan yang benar
      • Tautan file untuk file lokal
      • Tautan URL untuk file di luar docset
    • Menghapus lokal dari URL
    • Menyederhanakan URL yang menunjuk ke learn.microsoft.com
  • Verifikasi konten berversi sudah benar di semua versi
    • Tinjau laporan perubahan konten versi

Proses Penggabungan Cabang

Cabang main adalah satu-satunya cabang yang harus digabungkan ke dalam live. Penggabungan dari cabang sementara harus dilebur sebelum digabungkan ke dalam main.

Gabungkan dari/ke cabang rilis utama langsung
cabang kerja squash dan gabungkan squash dan gabungkan Tidak diizinkan
cabang rilis — gabungkan Tidak diizinkan
utama rebase (mengatur ulang basis) — gabungkan

Daftar periksa Penggabungan PR

  • Tinjauan konten selesai
  • Mengoreksi cabang target untuk perubahan
  • Tidak ada konflik penggabungan
  • Semua validasi dan langkah build berhasil
    • Peringatan dan saran harus diperbaiki (lihat catatan untuk pengecualian)
    • Tidak ada tautan yang rusak
    • Tindakan Daftar Periksa dijalankan dan berhasil
    • Jika pemeriksaan Otorisasi dipicu, pemeriksaan tersebut lulus
  • Gabungkan sesuai dengan tabel

Catatan

Peringatan berikut dapat diabaikan:

Can't find service name for `<version>/<modulepath>/About/About.md`

Metadata with following name(s) are not allowed to be set in YAML header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

Ketika PR digabungkan, HEAD dari cabang yang ditargetkan diubah. Setiap PR terbuka yang didasarkan pada HEAD sebelumnya sekarang sudah kedaluarsa. Maintainer memiliki hak yang diperlukan untuk mengabaikan peringatan penggabungan dan menggabungkan PR yang sudah kedaluwarsa di GitHub. Menggabungkan PR yang sudah ketinggalan jaman aman jika PR yang digabungkan sebelumnya tidak menyentuh file yang sama.

Untuk memperbarui PR, pilih tombol Perbarui Cabang. Pilih opsi Perbarui dengan opsi rebase. Untuk informasi selengkapnya, lihat Memperbarui cabang pull request Anda.

Penerbitan ke Langsung

Secara berkala, perubahan yang terakumulasi di cabang main perlu diterbitkan ke situs web yang aktif.

  • Cabang main digabungkan ke live setiap hari kerja pada pukul 15.00 PST.
  • Cabang main harus digabungkan ke live setelah perubahan signifikan.
    • Perubahan pada 50 file atau lebih
    • Setelah menggabungkan cabang rilis
    • Perubahan pada konfigurasi repositori atau docset (docfx.json, konfigurasi OPS, skrip build, dll.)
    • Perubahan pada file pengalihan
    • Perubahan pada TOC
    • Setelah menggabungkan cabang "proyek" (reorganisasi konten, pembaruan dalam jumlah besar, dll.)
  • Last updated on