Lompat ke konten
dokumentasi.id
Commit a27b09d
v2
Star11 rb

Kamu membaca versi lama. Halaman ini hanya bisa dibaca.

6

Frameworks dan Content Management System

README menyimpan pedoman framework dan CMS sebagai dua bagian datar yang berdiri sendiri. ## Frameworks memuat 4 entri dan ## Content Management System memuat 4 entri lain; keduanya tanpa sub-bagian ### dan tanpa satu pun deskripsi README.md:349-354 README.md:356-361. Posisi keduanya di daftar Contents jelas: tepat setelah ## Platforms dan tepat sebelum ## Tools README.md:5-12.

Halaman ini hanya membahas isi dua bagian itu. Pedoman tingkat platform dijelaskan di Platforms dan Desain API, pedoman bahasa di Bahasa Pemrograman, dan perangkat yang menegakkan aturan di Tools dan Linter.

Dua bagian tanpa sub-bagian

Bentuk ini berbeda dari ## Programming Languages, yang dipecah menjadi sub-bagian per bahasa seperti ### Ada dan ### C README.md:14-18. Di ## Frameworks dan ## Content Management System tidak ada pemecahan seperti itu, sehingga pembaca mencari nama proyek langsung di dalam satu daftar utuh.

BagianBarisJumlah entriSub-bagian ###Deskripsi per entri
## FrameworksREADME.md:349-3544tidak adatidak ada
## Content Management SystemREADME.md:356-3614tidak adatidak ada

Kedua bagian tetap berupa tautan polos, sehingga isi informasinya sepenuhnya bergantung pada judul entri dan URL tujuannya.

Delapan entri dan ekosistemnya

README tidak menuliskan bahasa untuk kedelapan entri. Kolom ekosistem di bawah diturunkan dari nama proyek dan domain pada URL tiap entri, bukan dari kalimat di README.

EntriBagianPola judulEkosistem
Symfony Coding StandardsFrameworksCoding StandardsPHP
Django Coding StyleFrameworksCoding StylePython
Vue Style GuideFrameworksStyle GuideJavaScript
Angular Style GuideFrameworksStyle GuideJavaScript
WordPress Coding StandardsCMSCoding StandardsPHP
Drupal Coding StandardsCMSCoding StandardsPHP
Magento Coding StandardsCMSCoding Standards (URL memuat segmen php)PHP
Octobercms Developer GuideCMSDeveloper GuidePHP

Tujuh entri memakai pola nama proyek ditambah Coding Standards, Coding Style, atau Style Guide. Hanya Octobercms Developer Guide yang memakai penamaan lain, dan judulnya ditulis Octobercms dengan huruf c kecil README.md:356-361.

Rantai dari ekosistem bahasa ke tool penegak

Kalau kedelapan entri dibaca sebagai satu rantai, pedoman framework dan CMS berdiri di atas pedoman bahasa dan di bawah tool yang menegakkan aturan. Rantai itu memakai entri yang memang ada di README: PHP FIG, PHP_CodeSniffer, dan PHP Coding Standards Fixer untuk sisi PHP README.md:180 README.md:372-373, ESLint untuk sisi JavaScript README.md:369, dan ## JavaScript sebagai bagian bahasa yang menampung pedoman JavaScript README.md:116-127.

graph TD
  subgraph fw["Frameworks (README.md:349-354)"]
    symfony["Symfony Coding Standards"]
    django["Django Coding Style"]
    vue["Vue Style Guide"]
    angular["Angular Style Guide"]
  end
  subgraph cms["Content Management System (README.md:356-361)"]
    wordpress["WordPress Coding Standards"]
    drupal["Drupal Coding Standards"]
    magento["Magento Coding Standards"]
    october["Octobercms Developer Guide"]
  end
  symfony --> php["PHP"]
  wordpress --> php
  drupal --> php
  magento --> php
  october --> php
  django --> python["Python"]
  vue --> js["JavaScript"]
  angular --> js
  php --> fig["PHP FIG"]
  php --> sniffer["PHP_CodeSniffer"]
  php --> fixer["PHP Coding Standards Fixer"]
  js --> eslint["ESLint"]
  fw --> gap["Deskripsi kosong 8 dari 8"]
  cms --> gap
  style fw fill:#f59e0b,color:#000
  style cms fill:#f59e0b,color:#000
  style php fill:#2d7d46,color:#fff
  style python fill:#2d7d46,color:#fff
  style js fill:#2d7d46,color:#fff
  style fig fill:#8b5cf6,color:#fff
  style sniffer fill:#8b5cf6,color:#fff
  style fixer fill:#8b5cf6,color:#fff
  style eslint fill:#8b5cf6,color:#fff
  style gap fill:#dc2626,color:#fff
%% fig: Rantai pedoman framework dan CMS
%% desc: Delapan entri mengarah ke ekosistem bahasanya lalu ke tool penegak aturan, dan satu node merah menandai celah deskripsi.
Fig. 1: Rantai pedoman framework dan CMSDelapan entri mengarah ke ekosistem bahasanya lalu ke tool penegak aturan, dan satu node merah menandai celah deskripsi.

Warna diagram dipakai konsisten: amber untuk entri pedoman framework dan CMS, hijau untuk ekosistem bahasa, ungu untuk tool yang menegakkan aturan, dan merah untuk temuan yang menyimpang dari pedoman kontribusi.

Satu cabang diagram berhenti di ekosistem Python. ## Python memuat 3 entri, yaitu Style Guide for Python Code (PEP 8), Google Python Style Guide, dan The Hitchhiker's Guide to Python README.md:184-188, sementara ## Tools tidak memuat tool khusus Python README.md:363-376. Jadi Django Coding Style tidak punya pasangan tool di README pada saat ini.

Penyimpangan dari pedoman kontribusi

⚠️ Tidak ada satu pun dari kedelapan entri yang menyertakan deskripsi. contributing.md meminta deskripsi singkat untuk setiap entri dan format [Title](url) - Description. contributing.md:22-23, padahal semua baris di dua bagian itu berhenti tepat setelah URL README.md:349-354 README.md:356-361.

⚠️ Urutan alfabetis juga belum terjaga. ## Frameworks membuka dengan Symfony Coding Standards namun menutup dengan Angular Style Guide, dan ## Content Management System membuka dengan WordPress Coding Standards sebelum Drupal Coding Standards dan Magento Coding Standards README.md:349-354 README.md:356-361. Padahal contributing.md meminta tautan dan kategori diurutkan alfabetis contributing.md:26.

Kedua temuan itu berlaku hanya untuk isi bagian, bukan untuk struktur berkasnya. Aturan penulisan entri secara umum, termasuk pemilihan kategori, dibahas di Panduan Kontribusi dan Kode Etik, sedangkan pemeriksaan otomatis atas hasil akhirnya dibahas di Pipeline Lint dan CI.