Ringkasan Proyek

Awesome Guidelines adalah katalog kurasi yang menghimpun tautan panduan gaya, praktik terbaik, dan konvensi penulisan kode. Ruang lingkupnya dinyatakan langsung pada baris pembuka README.md:1-3¹. Proyek ini tidak menjalankan layanan, tidak menyimpan data, dan tidak mengolah request; seluruh nilainya berada pada isi katalog.

Katalog itu hidup di satu berkas, yaitu README.md. Tidak ada direktori per kategori maupun schema basis data. Blok Contents menautkan enam kategori besar, dan keenam tautan itulah yang menjadi kerangka dokumentasi ini README.md:5-12².

Enam kategori dan halaman yang membahasnya

Diagram berikut memetakan satu berkas sumber ke enam kategori, lalu ke halaman dokumentasi yang merinci tiap kategori.

graph TD
  R["README.md"] --> PL["Programming Languages<br/>43 sub-bagian"]
  R --> DE["Development Environment<br/>3 sub-bagian"]
  R --> PF["Platforms<br/>15 sub-bagian"]
  R --> FW["Frameworks"]
  R --> CMS["Content Management System"]
  R --> TO["Tools"]
  PL --> H31["bahasa-pemrograman"]
  DE --> H32["lingkungan-pengembangan"]
  PF --> H33["platform"]
  FW --> H34["framework-cms-dan-tools"]
  CMS --> H34
  TO --> H34
  style R fill:#336791,color:#fff
  style PL fill:#2d7d46,color:#fff
  style DE fill:#f59e0b,color:#000
  style PF fill:#f59e0b,color:#000
  style FW fill:#f59e0b,color:#000
  style CMS fill:#f59e0b,color:#000
  style TO fill:#f59e0b,color:#000
  style H31 fill:#8b5cf6,color:#fff
  style H32 fill:#8b5cf6,color:#fff
  style H33 fill:#8b5cf6,color:#fff
  style H34 fill:#8b5cf6,color:#fff
%% fig: Pemetaan README.md ke enam kategori dan halaman dokumentasi
%% desc: Satu berkas README.md menampung enam kategori; Programming Languages menjadi kategori terbesar dengan 43 sub-bagian, sementara Frameworks, Content Management System, dan Tools berbagi satu halaman dokumentasi.

Tabel berikut merangkum rentang baris tiap kategori di README.md, bentuk penomorannya, dan halaman yang membahasnya secara rinci.

Ukuran setiap kategori berbeda jauh. Programming Languages memakai hampir dua pertiga berkas, sedangkan Frameworks dan Content Management System sama-sama ditulis sebagai daftar datar tanpa sub-bagian. Rincian tiap entri ada di Katalog Panduan; bentuk penulisan entri dan urutan abjadnya dibahas di Format Entri dan Pengurutan.

Perkakas dan lisensi

Satu-satunya perkakas yang dideklarasikan adalah awesome-lint. Script test di package.json hanya menjalankan perintah tersebut, dengan devDependencies yang dipatok ke versi v2.3.0 package.json:2-7⁹. Berkas test.js menjadi pintu masuknya: berkas itu me-require modul awesome-lint lalu memanggil awesomeLint.report() test.js:1-3¹⁰. Bagaimana pemeriksaan ini dijalankan sebagai quality gate dijelaskan di Quality Gate dan CI.

Lisensi proyek adalah CC0 1.0 Universal, yang melepaskan karya ke public domain tanpa syarat atribusi LICENSE:1-1.

⚠️ README.md adalah satu-satunya sumber isi katalog. Setiap penambahan entri mengubah berkas yang sama, sehingga dua pull request yang menyisipkan baris pada kategori yang sama akan berbenturan saat merge. Aturan penulisan dan pengurutan entri wajib diikuti sebelum membuka pull request; lihat Proses Kontribusi.

Struktur berkas di tingkat repository, termasuk berkas pendukung seperti contributing.md dan code-of-conduct.md, dibahas di Arsitektur Repository. Kebijakan pemeliharaan jangka panjangnya ada di Tata Kelola dan Pemeliharaan.