Berkontribusi menggunakan GitHub Codespaces

GitHub memiliki fitur yang disebut Codespace yang dapat Anda gunakan untuk berkontribusi pada dokumentasi PowerShell tanpa harus menginstal atau mengonfigurasi perangkat lunak apa pun secara lokal. Saat Anda menggunakan codespace, Anda mendapatkan alat penulisan yang sama yang digunakan tim untuk menulis dan mengedit.

Anda dapat menggunakan codespace di browser Anda, memungkinkan Anda untuk berkontribusi dengan VS Code yang dihosting melalui internet. Jika Anda telah menginstal Visual Studio Code secara lokal, Anda juga dapat terhubung ke codespace di sana.

Alat yang tersedia

Saat Anda menggunakan codespace untuk berkontribusi pada dokumentasi PowerShell, editor Anda memiliki alat ini yang sudah tersedia untuk Anda:

  • Markdownlint untuk memeriksa sintaks Markdown Anda.
  • cSpell untuk memeriksa ejaan Anda.
  • Vale untuk memeriksa prosa Anda.
  • Learn Authoring Pack untuk menyisipkan sintaksis khusus platform, mempratinjau kontribusi Anda, dan banyak lagi.
  • Ekstensi Markdown Reflow untuk membungkus Markdown Anda sesuai kebutuhan, membuat membaca dan mengedit lebih mudah.
  • Ekstensi Table Formatter untuk membuat tabel Anda lebih mudah dibaca tanpa harus meratakan kolom secara manual.
  • Ekstensi change-case untuk mengonversi casing judul dan prosa Anda.
  • Ekstensi GitLens untuk meninjau perubahan file historis.
  • Ekstensi PowerShell untuk berinteraksi menulis contoh PowerShell.
  • Pelacak Gremlins untuk Visual Studio Code untuk menemukan karakter-karakter bermasalah dalam Markdown Anda.

Biaya

GitHub Codespaces dapat digunakan secara gratis hingga 120 jam inti per bulan. Penggunaan bulanan dihitung di semua repositori Anda, bukan hanya dokumentasi.

Untuk informasi selengkapnya tentang harga, lihat Tentang penagihan untuk GitHub Codespaces.

Petunjuk / Saran

Jika Anda nyaman menggunakan kontainer dan Docker, Anda bisa mendapatkan pengalaman yang sama dengan menggunakan devcontainer yang ditentukan untuk repositori dokumentasi PowerShell. Tidak ada biaya yang terkait dengan penggunaan devcontainer. Untuk informasi selengkapnya, lihat tutorial Kontainer Dev.

Membuat Codespace GitHub Anda

Untuk membuat GitHub Codespace Anda untuk berkontribusi pada dokumentasi PowerShell, ikuti langkah-langkah berikut:

  1. Buka https://github.com/codespaces di browser Anda.
  2. Pilih tombol "Codespace baru" di kanan atas halaman.
  3. Di halaman "Buat codespace baru", pilih tombol "Pilih repositori" dan ketik nama repositori yang ingin Anda kontribusikan, seperti MicrosoftDocs/PowerShell-Docs.
  4. Biarkan semua pengaturan lain sebagai defaultnya.
  5. Pilih tombol "Buat codespace".

Setelah mengikuti langkah-langkah ini, GitHub membuat ruang kode baru untuk repositori tersebut dan menyiapkannya untuk Anda. Saat codespace siap, halaman me-refresh dan menampilkan antarmuka pengguna editor web untuk codespace. UI didasarkan pada Visual Studio Code dan bekerja dengan cara yang sama.

Membuka Codespace GitHub Anda

Untuk membuka GitHub Codespace Anda di browser, ikuti langkah-langkah berikut:

  1. Buka https://github.com/codespaces di browser Anda.
  2. Halaman mencantumkan Codespaces Anda. Temukan codespace yang dibuat untuk repositori yang ingin Anda kontribusikan dan pilih.

Setelah Anda memilih codespace, GitHub akan membukanya di jendela yang sama. Dari sini, Anda siap untuk berkontribusi.

Untuk membuka Ruang Kode GitHub Anda di Visual Studio Code, ikuti langkah-langkah dalam Menggunakan GitHub Codespaces di Visual Studio Code.

Pengeditan di Codespace GitHub Anda

Setelah Anda membuka GitHub Codespace di browser atau Visual Studio Code, berkontribusi pada dokumentasi mengikuti proses yang sama.

Sisa artikel ini menjelaskan pilihan tugas yang dapat Anda lakukan di Ruang Kode GitHub Anda saat menulis atau mengedit kontribusi Anda.

Saat Anda ingin mengubah tautan sebaris, seperti [some text](destination.md), menjadi tautan referensi seperti [some text][01], pilih tujuan tautan di editor. Kemudian Anda dapat:

  1. Klik kanan pada tujuan tautan dan pilih "Refaktor..." di menu konteks.
  2. Tekan Ctrl+Shift+R.

Salah satu tindakan menaikkan menu konteks pemfaktoran ulang. Untuk mengganti (destination.md) di tautan dengan [def], pilih Ekstrak ke definisi tautan di menu konteks. Anda dapat mengganti nama definisi dengan mengetikkan nama.

Untuk dokumentasi PowerShell, kami menggunakan definisi tautan referensi numerik dua digit, seperti [01] atau [31]. Hanya gunakan definisi tautan referensi dalam artikel dan dokumentasi konseptual. Jangan gunakan definisi tautan referensi dalam dokumentasi referensi cmdlet.

Memperbaiki pelanggaran gaya prosa

Saat Anda meninjau artikel di ruang kode Anda, Vale secara otomatis memeriksa artikel ketika Anda pertama kali membukanya dan setiap kali Anda menyimpannya. Jika Vale menemukan pelanggaran gaya, Vale menyorotnya dalam dokumen dengan garis bergelombang berwarna.

Arahkan mouse ke atas pelanggaran untuk melihat informasi selengkapnya tentang hal itu.

Untuk membuka halaman web yang menjelaskan aturan, pilih nama aturan di informasi hover. Untuk membuka aturan dan meninjau implementasinya, pilih nama file aturan (berakhiran .yml).

Jika aturan mendukung perbaikan cepat, Anda dapat memilih "Perbaikan Cepat..." di informasi hover untuk pelanggaran dan terapkan salah satu perbaikan yang disarankan dengan memilihnya dari menu konteks. Anda juga dapat menekan Ctrl+. saat kursor Anda berada pada masalah yang disorot untuk menerapkan perbaikan cepat jika aturan mendukungnya.

Jika aturan tidak mendukung perbaikan cepat, baca pesan aturan dan perbaiki jika Anda bisa. Jika Anda tidak yakin cara memperbaikinya, editor dapat membuat saran saat meninjau PR Anda.

Memperbaiki masalah sintaks

Saat Anda meninjau artikel di codespace Anda, Markdownlint secara otomatis memeriksa artikel saat Anda membukanya dan saat Anda mengetik. Jika Markdownlint menemukan masalah sintaksis, Markdownlint akan menyorotinya dalam dokumen dengan garis berlekuk warna-warni.

Arahkan mouse ke atas pelanggaran untuk melihat informasi selengkapnya tentang hal itu. Untuk membuka halaman web yang menjelaskan aturan, pilih ID aturan di informasi saat kursor melayang.

Jika aturan mendukung perbaikan cepat, Anda dapat memilih "Perbaikan Cepat..." di informasi hover untuk pelanggaran dan terapkan salah satu perbaikan yang disarankan dengan memilihnya dari menu konteks. Anda juga dapat menekan Ctrl+. saat kursor Anda berada pada masalah yang disorot untuk menerapkan perbaikan cepat jika aturan mendukungnya.

Jika aturan tidak mendukung perbaikan cepat, baca pesan aturan dan perbaiki jika Anda bisa. Jika Anda tidak yakin cara memperbaikinya, editor dapat membuat saran saat meninjau PR Anda.

Anda juga dapat menerapkan perbaikan untuk semua pelanggaran sintaks dalam artikel. Untuk melakukannya, buka palet perintah dan ketik Fix all supported markdownlint violations in the document. Saat Anda mengetik, palet perintah memfilter perintah yang tersedia. Pilih perintah "Perbaiki semua pelanggaran markdownlint yang didukung dalam dokumen". Saat Anda melakukannya, Markdownlint memperbarui dokumen untuk memperbaiki pelanggaran yang dapat segera diperbaiki.

Format tabel

Untuk memformat tabel Markdown, tempatkan kursor Anda di dalam atau pada tabel di Markdown Anda. Buka Palet Perintah dan cari Table: Format Current perintah . Saat Anda memilih perintah tersebut, Markdown untuk tabel Anda akan diperbarui untuk meratakan dan memberi jarak pada tabel guna meningkatkan keterbacaan.

Proses ini mengonversi tabel yang didefinisikan dengan cara seperti ini:

| foo | bar | baz |
|:--:|:--|-:|
| a | b | c |

Menjadi ini:

|  foo  | bar  | baz  |
| :---: | :--- | ---: |
|   a   | b    |    c |

Menyisipkan pemberitahuan

Dokumentasi menggunakan pemberitahuan untuk membuat informasi lebih penting kepada pembaca.

Untuk menyisipkan pemberitahuan, Anda bisa, buka Palet Perintah dan cari Learn: Alert perintah . Saat Anda memilih perintah tersebut, perintah akan membuka menu konteks. Pilih jenis pemberitahuan yang ingin Anda tambahkan. Saat Anda melakukannya, perintah menyisipkan Markdown peringatan pada posisi kursor Anda di dalam dokumen.

Membuat judul menggunakan casing kalimat

Untuk mengubah casing judul, sorot teks judul kecuali simbol awal # yang menunjukkan tingkat judul. Saat teks disorot, buka Palet Perintah dan cari perintah Change case sentence. Saat Anda memilih perintah tersebut, casing teks yang disorot akan diubah.

Anda juga dapat menggunakan perintah casing untuk teks apa pun dalam dokumen.

Buka Palet Perintah

Anda dapat menggunakan Palet Perintah Visual Studio Code untuk menjalankan banyak perintah bermanfaat.

Untuk membuka Palet Perintah di UI, pilih "Lihat" di bilah menu atas. Kemudian pilih "Palet Perintah..." di menu konteks.

Untuk membuka Palet Perintah dengan keyboard Anda, tekan kombinasi tombol untuk sistem operasi Anda:

  • Windows dan Linux: Ctrl+Shift+P
  • macOS: Cmd+Shift+P

Pratinjau kontribusi Anda

Untuk mempratinjau kontribusi Anda, buka Palet Perintah dan cari Markdown: Open Preview perintah . Saat Anda memilih perintah tersebut, VISUAL Code akan membuka pratinjau dokumen aktif. Gaya pratinjau sesuai dengan Platform Learn.

Nota

Tautan yang bersifat relatif terhadap situs dan referensi silang tidak berfungsi dalam pratinjau.

Sesuaikan ulang tata letak konten Anda

Untuk membatasi panjang baris untuk paragraf dalam dokumen, letakkan kursor Anda pada paragraf. Kemudian buka Palet Perintah dan cari Reflow Markdown perintah . Saat Anda memilih perintah, perintah akan memperbarui panjang baris paragraf saat ini ke panjang yang dikonfigurasi. Untuk repositori kami, panjangnya adalah 99 karakter.

Saat menggunakan perintah ini untuk tanda kutip blok, pastikan paragraf dalam tanda kutip blok yang Anda arus ulang dikelilingi oleh baris kosong. Jika tidak, perintah akan me-reflow setiap paragraf secara bersamaan.

Perhatian

Jangan gunakan perintah ini saat mengedit tentang artikel. Baris dalam dokumen tersebut tidak boleh lebih panjang dari 80 karakter. Saat ini tidak ada cara bagi repositori untuk mengonfigurasi panjang baris yang berbeda menurut folder atau nama file, sehingga reflow tidak berfungsi untuk dokumen artikel.

Meninjau semua masalah dalam dokumen

Untuk meninjau semua pelanggaran aturan sintaksis dan gaya dalam dokumen, buka Tampilan Masalah.

Untuk membuka Tampilan Masalah di UI, pilih "Lihat" di bilah menu atas. Kemudian pilih "Masalah" di menu konteks.

Untuk membuka Tampilan Masalah dengan keyboard Anda, tekan kombinasi tombol untuk sistem operasi Anda:

  • Windows dan Linux: Ctrl+Shift+M
  • macOS: Cmd+Shift+M

Tampilan Masalah menampilkan semua kesalahan, peringatan, dan saran untuk dokumen yang terbuka. Pilih masalah untuk menggulir ke masalah tersebut dalam dokumen.

Anda dapat memfilter masalah berdasarkan jenis atau pencocokan teks.

Memperbarui metadata ms.date

Untuk memperbarui ms.date metadata untuk artikel, buka Palet Perintah dan cari Learn: Update "ms.date" Metadata Value perintah . Saat Anda memilih perintah, perintah akan memperbarui metadata ke tanggal saat ini.

Sumber daya tambahan

Tugas dan perintah yang dijelaskan dalam artikel ini tidak mencakup semua yang dapat Anda lakukan dengan Visual Studio Code atau ekstensi yang diinstal.

Untuk informasi selengkapnya tentang menggunakan Visual Studio Code, lihat artikel berikut ini:

Untuk informasi selengkapnya tentang ekstensi yang diinstal, lihat dokumentasinya:

  • Last updated on