eSchool Dev Docs

Konvensi Kode

Aturan penamaan, commit, branch, dan pull request

Penamaan

HalAturanContoh
ClassPascalCaseStudentController
Method dan variabelcamelCasegetActiveStudents
Tabel dan kolomsnake_casestudent_classes
Route namekebab-case atau dotstudents.index

Gaya kode

Ikuti PSR-12. Rapikan kode otomatis sebelum commit:

./vendor/bin/pint

Branch

  • main: kode production
  • develop: kode integrasi
  • feature/nama-fitur: fitur baru
  • fix/nama-bug: perbaikan bug

Pesan commit

Format: tipe: deskripsi singkat

feat: tambah filter kelas di daftar siswa
fix: perbaiki nilai rata-rata yang salah hitung
docs: perbarui panduan setup lokal
refactor: pindahkan logika tagihan ke service

Pull request

  • Judul jelas dan singkat.
  • Jelaskan apa yang berubah dan kenapa.
  • Sertakan langkah untuk mengujinya.
  • Perbarui dokumentasi bila perlu.
  • Minimal satu reviewer menyetujui sebelum merge.

On this page