Struktur Repository

Kristories/awesome-guidelines bukan aplikasi. Hampir seluruh isinya berupa satu katalog tautan di README.md, ditambah tooling lint Node dan berkas tata kelola kecil di tingkat root. Tidak ada direktori konten, sehingga pembagian repository ini bersifat datar. Halaman ini memetakan peran setiap berkas dan arah ketergantungannya; isi katalognya dibahas di Ringkasan Proyek, sedangkan eksekusi lint dibahas di Pipeline Lint dan CI.

Peta ketergantungan berkas

graph TD
  COC["code-of-conduct.md"] --> GOV["contributing.md"]
  GOV --> TPL["pull request template"]
  TPL --> PR["pull request ke master"]
  PR --> WFL["lint.yml"]
  WFL --> CLI["npx awesome-lint"]
  CLI --> RM["README.md"]
  PKG["package.json"] --> LOCK["package-lock.json"]
  LOCK --> CLI
  DEP["dependabot.yml"] --> LOCK
  STALE["stale.yml"] --> OLD["issue dan pull request tanpa aktivitas"]
  ED["editorconfig + gitattributes"] -.-> RM
  TR["travis.yml"] -.-> CLI
  style RM fill:#336791,color:#fff
  style LOCK fill:#8b5cf6,color:#fff
  style WFL fill:#2d7d46,color:#fff
  style CLI fill:#2d7d46,color:#fff
  style PKG fill:#f59e0b,color:#000
  style ED fill:#f59e0b,color:#000
  style DEP fill:#f59e0b,color:#000
  style TR fill:#dc2626,color:#fff
%% fig: Ketergantungan berkas di repository
%% desc: Konten dan tooling lint bertemu di satu workflow, sementara berkas tata kelola menjadi gerbang sebelum pull request dijalankan.

Gambar di atas menunjukkan bahwa README.md adalah satu-satunya berkas yang diperiksa lint, sedangkan berkas lain menjadi masukan atau pemicu. package-lock.json diberi warna berbeda karena isinya diturunkan dari package.json. travis.yml diberi warna merah karena berada di luar .github/workflows/ travis.yml:1-5¹.

Konten: satu README.md

README.md dibuka dengan judul dan badge Awesome README.md:1-3². Setelah itu daftar isi menautkan enam bagian: Programming Languages, Development Environment, Platforms, Frameworks, Content Management System, dan Tools README.md:5-12³. Setiap bahasa ditulis sebagai subbagian ### di bawah ## Programming Languages, misalnya ### Ada dan ### Brainfuck README.md:14-18⁴. Katalog berakhir pada bagian Tools di baris terakhir, sehingga seluruh isi repository ini berada dalam 376 baris README.md README.md:363-376⁵.

Tooling lint Node

package.json hanya memuat dua hal: script test yang menjalankan awesome-lint, dan satu devDependency awesome-lint pada versi v2.3.0 package.json:1-8⁶. package-lock.json mengunci paket itu pada versi 2.3.0 dengan tarball dari registry npm package-lock.json:319-324⁷. test.js adalah pembungkus tiga baris yang memuat modul awesome-lint lalu memanggil awesomeLint.report() test.js:1-3⁸. Hasil instalasi tidak ikut masuk repository karena .gitignore hanya memuat node_modules/ .gitignore:1-1.

⚠️ package-lock.json memuat kunci ganda. Baris 8 mencetak "awesome-lint": "v2.3.0" dua kali package-lock.json:1-10⁹, dan entri node_modules/awesome-lint mencetak version, resolved, serta integrity masing-masing dua kali package-lock.json:319-324⁷. Pasangan kunci berulang membuat berkas ini tidak lolos parser JSON yang ketat, sehingga instalasi ulang lewat npm ci tidak bisa diandalkan.

Workflow GitHub Actions

Workflow lint.yml hanya menyala pada pull_request ke master; tidak ada pemicu push .github/workflows/lint.yml:1-14¹⁰. Langkah terakhirnya menjalankan npx awesome-lint, bukan npm test, sehingga script test dan test.js tidak dipakai oleh workflow .github/workflows/lint.yml:1-14¹⁰. Di sisi lain, stale.yml menandai issue dan pull request sebagai stale setelah 20 hari tanpa aktivitas lalu menutupnya satu hari kemudian .github/workflows/stale.yml:1-21¹¹. dependabot.yml memeriksa ekosistem npm di direktori akar setiap hari dan menugaskan hasilnya kepada kristories .github/dependabot.yml:1-10¹².

⚠️ travis.yml di root tidak berada di .github/workflows/, dan namanya tanpa titik depan, sehingga GitHub Actions maupun Travis tidak membacanya sebagai pipeline aktif. Isinya hanya language: node_js, node_js: node, dan dua baris komentar travis.yml:1-5¹.

Berkas tata kelola

contributing.md menetapkan format dan tata urutan entri contributing.md:19-31¹³; rinciannya dibahas di Panduan Kontribusi dan Kode Etik. code-of-conduct.md membuka dengan tujuan proyek lalu menetapkan perilaku yang diharapkan code-of-conduct.md:1-6¹⁴. Template pull request tidak memakai front matter: isinya satu paragraf dan satu baris panah, dan berkas pada path itu otomatis muncul di badan setiap pull request Kristories/awesome-guidelines .github/pull_request_template.md:1-3¹⁵. LICENSE memakai CC0 1.0 Universal LICENSE:1-1.

Konvensi lintas editor

.editorconfig menetapkan akar konfigurasi lewat root = true dan memberlakukan akhir baris LF serta indentasi dua spasi untuk seluruh berkas .editorconfig:1-21. .gitattributes menormalkan akhir baris ke LF dan memakai *.md merge=union, sehingga dua penambahan pada berkas Markdown yang sama digabung otomatis .gitattributes:1-17.

⚠️ Ada aturan yang bertentangan untuk berkas Markdown. .editorconfig mematikan pemangkasan trailing whitespace khusus *.md .editorconfig:11-12, sementara butir terakhir pedoman kontribusi meminta teks editor disetel untuk menghapus trailing whitespace contributing.md:19-31¹³. Pilih satu acuan agar hasil commit konsisten.