📌 Dokumentasi ini memberikan guidelines dalam pengembangan project secara keseluruhan. Daftar guidelines akan diperbarui secara berkala.

Pengembangan dan penulisan kode dalam project ini sangat disarankan menerapkan konsep Javascript Clean Code. Sebagian besar aturan dalam pengembangan project akan didasarkan pada konsep Javascript Clean Code tersebut.

https://github.com/ryanmcdermott/clean-code-javascript

Seluruh penulisan penamaan menggunakan bahasa inggris

• Nama file dan folder ditulis menggunakan lowercase tanpa spasi. Apabila terdiri lebih dari satu kata, maka dipisah menggunakan - .

  • cat-image.png
  • folder image

• Nama file dan folder boleh disingkat

  • folder src
  • success-img.jpg

• Nama file harus merepresentasikan isi file

  ✔ core-image.png

  ❌ pngwing-a1231.png

• Satu jenis gambar yang memiliki variasi diberi suffiks

  • hero-image-lg.png : untuk gambar hero ukuran resolusi large
  • hero-image-md.png : untuk gambar hero yang sama dengan ukuran resolusi medium
  • hero-image-sm.png : untuk gambar hero yang sama dengan ukuran resolusi small

• Nama fungsi dan variable menggunakan camelCase

  • openDashboard()
  • sendData()
  • userData

• Nama fungsi dan variable sangat disarankan untuk tidak disingkat

  ✔ createNewUserAccount()

  ❌ createNewUserAcc()

  📌 Lebih baik nama terlalu panjang namun jelas maknanya daripada pendek namun ambigu.

• Nama variabel konstan const selain fungsi ditulis kapital.

  • const BIRTHDATE;
  • const myFunction();

• Nama kelas ditulis menggunakan PascalCase
  • class Car

Untuk membuat Pull Request terdapat beberapa aturan yang perlu diikuti.

<Pull Request Title>

Judul Pull Request Title harus mencerminkan tujuan pull request secara jelas.

• Pull request yang merupakan bagian dari suatu task project harus dihubungkan ke task terkait.

• Nama branch menggunakan lowercase
• Branch yang merupakan bagian dari task yang memiliki package ID (PID) harus diberikan PID pada nama branch <container>/<pid>/<branch-name>