Lompat ke konten
dokumentasi.id
Commit a27b09d
v2
Star11 rb

4

Development Environment

README.md menaruh Development Environment sebagai bagian tingkat dua kedua, tepat setelah Programming Languages dan sebelum Platforms, baik pada daftar Contents maupun pada urutan judul README.md:5-13. Isinya sempit dan disiplin: tiga subsection, yaitu Shell, Git, dan PowerShell, yang bersama-sama memuat empat tautan README.md:246-259. Tidak ada prosa penjelas di dalam bagian ini; setiap baris adalah satu butir daftar berisi tautan dan satu kalimat deskripsi.

Subsection dan entri

Tabel berikut memetakan setiap butir ke subsection-nya, sesuai urutan baris di berkas.

SubsectionEntriDeskripsi tertulisBaris
### ShellShell Style GuideShell script style guide.README.md:248-250
### GitGit Style GuideGit usage and style recommendations.README.md:252-254
### GitFew Rules from Git DocumentationCoding guidelines used in the Git project.README.md:255
### PowerShellThe PowerShell Best Practices and Style GuideThe Unofficial PowerShell Best Practices and Style Guide.README.md:257-259

Tiga subsection itu mewakili tiga lapisan lingkungan kerja yang berbeda. Shell menyumbang satu pedoman untuk skrip baris perintah README.md:248-250, Git menyumbang dua butir tentang kontrol versi README.md:252-255, dan PowerShell menyumbang satu pedoman gaya untuk shell Windows README.md:257-259. Bagian ini adalah satu-satunya tempat daftar menyentuh perkakas harian pengembang; bahasa pemrograman dibahas di Bahasa Pemrograman, sedangkan sistem operasi dan target API dibahas di Platforms dan Desain API.

Perjalanan satu entri sampai terbit

Karena tidak ada prosa, satu entri hanya punya dua pekerjaan: diletakkan pada subsection yang benar dan ditulis dengan format yang sama seperti butir lain. Alur di bawah menunjukkan keadaan yang dilalui sebuah tautan, termasuk dua jalur yang membatalkannya.

stateDiagram-v2
  [*] --> Usulan
  Usulan --> Duplikat: sudah ada di daftar
  Duplikat --> [*]
  Usulan --> Diformat: belum ada
  Diformat --> Ditempatkan: "[Title](url) - Description."
  Ditempatkan --> Diurutkan: alfabetis per kategori
  Diurutkan --> Lint
  Lint --> Terbit: lolos
  Lint --> Diformat: gagal
  Terbit --> [*]
  style Duplikat fill:#dc2626,color:#fff
  style Diformat fill:#f59e0b,color:#000
  style Ditempatkan fill:#8b5cf6,color:#fff
  style Lint fill:#f59e0b,color:#000
  style Terbit fill:#2d7d46,color:#fff
%% fig: Keadaan satu entri di bagian Development Environment
%% desc: Entri baru melewati penyaringan duplikat, penyeragaman format, penempatan subsection, lalu gerbang lint sebelum terbit.
Fig. 1: Keadaan satu entri di bagian Development EnvironmentEntri baru melewati penyaringan duplikat, penyeragaman format, penempatan subsection, lalu gerbang lint sebelum terbit.

Aturan yang mengisi diagram itu datang dari contributing.md: pencarian saran sebelumnya untuk menghindari duplikat, format [Title](url) - Description., pengurutan tautan dan kategori secara alfabetis, serta satu tautan per pull request contributing.md:21-27. Gerbang terakhirnya adalah npm test yang menjalankan awesome-lint package.json:2-4, dengan test.js hanya memanggil awesomeLint.report() test.js:1-3. Rincian pipeline itu ada di Pipeline Lint dan CI.

⚠️ Entri yang mirip mudah salah kamar. Pedoman gaya shell di sini bukan pedoman tooling, dan Git di sini bukan pedoman platform; kalau ragu, periksa dulu daftar Contents di README.md:5-13 sebelum menambah subsection baru di bawah README.md:246-259.

Satu konsekuensi lain: karena Shell dan PowerShell masing-masing hanya berisi satu butir, penghapusan satu baris akan mengosongkan subsection, sedangkan Git masih menyisakan satu butir README.md:252-255. Bagian ini karena itu paling rapuh terhadap penyuntingan yang menghapus tanpa mengganti.