Doc: mengedit readme

Descripsi - menambahkan contoh commit No Issue
2023-07-27 15:41:41 +08:00
parent 99c21f0ce4
commit 270d960f63
1 changed files with 109 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -11,6 +11,115 @@ __Team__
 - lia
 - malik

+### note 
+1. panter module bisa mengikuti contoh
+2. untuk commit beri keterangan lengkap dan jelas
+    
+    **Pantern**
+    1. Tag Commit (Commit Tag)
+    2. Deskripsi (Description)
+    3. Body
+    4. Referensi Isu (Issue References)
+    
+    **Contoh**
+    ```txt
+    feat: Tambahkan fitur kalkulator
+
+    Deskripsi:
+    - Menambahkan fungsi penambahan, pengurangan, perkalian, dan pembagian
+    - Memperbolehkan pengguna untuk memasukkan dua angka dan melakukan operasi matematika
+
+    Fixes #12
+    ```
+
+    **Refrensi**
+
+   1. **`fix`**: Digunakan untuk menandakan perbaikan bug atau masalah yang ada dalam kode.
+
+   Contoh:
+   ```
+   fix: Perbaiki bug tampilan pada halaman profil
+
+   Deskripsi:
+   - Mengatasi masalah tampilan yang menyebabkan foto profil tumpang tindih dengan teks
+
+   Fixes #55
+   ```
+
+   1. **`docs`**: Digunakan ketika melakukan perubahan pada dokumentasi proyek, seperti menambahkan atau mengedit komentar, README, atau file dokumentasi lainnya.
+
+   Contoh:
+   ```
+   docs: Update README dengan panduan instalasi
+
+   Deskripsi:
+   - Menyediakan petunjuk langkah demi langkah tentang cara menginstal dan menjalankan proyek
+
+   No Issue
+   ```
+
+   1. **`chore`**: Digunakan untuk komit yang berhubungan dengan pekerjaan rutin, seperti pembaruan dependensi, pengaturan konfigurasi, atau tugas administratif lainnya.
+
+   Contoh:
+   ```
+   chore: Pembaruan versi library requests
+
+   Deskripsi:
+   - Memperbarui library requests ke versi terbaru untuk meningkatkan keamanan dan kinerja
+
+   No Issue
+   ```
+
+   1. **`refactor`**: Digunakan ketika melakukan refaktorisasi kode, yaitu mengubah struktur atau tata letak kode tanpa mengubah perilaku yang terlihat dari luar.
+
+   Contoh:
+   ```
+   refactor: Ubah struktur kode halaman detail produk
+
+   Deskripsi:
+   - Memisahkan logika tampilan dari logika bisnis untuk meningkatkan keterbacaan dan pemeliharaan kode
+
+   No Issue
+   ```
+
+   1. **`test`**: Digunakan ketika melakukan perubahan atau penambahan tes atau skrip pengujian.
+
+   Contoh:
+   ```
+   test: Tambahkan tes unit untuk fungsi kalkulator
+
+   Deskripsi:
+   - Menulis tes unit untuk memastikan fungsi kalkulator berjalan dengan benar
+
+   No Issue
+   ```
+
+   1. **`style`**: Digunakan ketika melakukan perubahan pada tampilan atau gaya kode, tanpa mengubah logika atau perilaku program.
+
+   Contoh:
+   ```
+   style: Atur tata letak tombol 'Masuk'
+
+   Deskripsi:
+   - Memperbaiki tampilan tombol 'Masuk' pada halaman login agar lebih serasi
+
+   No Issue
+   ```
+
+   1. **`perf`**: Digunakan ketika melakukan perubahan untuk meningkatkan kinerja aplikasi atau mengoptimalkan kode.
+
+   Contoh:
+   ```
+   perf: Optimalkan penggunaan sumber daya gambar
+
+   Deskripsi:
+   - Mengurangi ukuran gambar dan mengimplementasikan caching untuk mempercepat waktu muat halaman
+
+   Fixes #102
+   ```
+
+
+