Apa itu Changelog? Manfaat, Contoh dan Penulisan Changelog

{tocify} $title={Table of Contents}

Mengenal Changelog

Jika kita memiliki aktivitas atau pekerjaan yang memerlukan sebuah catatan, seharusnya kita telah mengenal apa itu Changelog, jadi changelog adalah sebuah file berisi daftar perubahan dari project yang kita kerjakan, dan perubahan itu diurutkan secara kronologis untuk setiap versinya.

Manfaat Menulis Changelog

Dengan adanya file changelog atau catatan perubahan di project kita, dapat mempermudah pengguna dan kontributor project untuk melihat perubahan apa saja yang telah terjadi pada berkas project yang dirilis pada setiap versinya. Berkas inilah yang sering dibutuhkan oleh kontributor sebuah project, sehingga mereka tau apa yang telah berubah dan mengapa perubahan itu dilakukan.

Cara Membuat Changelog

Tidak hal rumit dalam membuat catatan perubahan, paling penting adalah catatan yang dibuat bisa dengan mudah dipahami oleh orang lain ( kontributor, atau pengguna )

A. Prinsip Penulisan

Sebelum kita menulis changelog, kita perlu mengetahui prinsip-prinsip dasar penulisan, yaitu sebagai berikut :

1. Harus berisi catatan perubahan yang terdapat pada setiap versi yang dirilis.
   Apa yang ada di changelog harus sesuai dengan perubahan yang ada di setiap versi yang dirilis
2. Setiap perubahan yang sama, harus dikelompokan Contoh : Jika ada 5 penambahan fitur maka dikelompokan pada kategori Ditambahkan, dan jika ada 2 perbaikan maka dikelompokan pada kategori Diperbaiki
3. Catatan perubahan harus merujuk ke perubahan yang ada pada versi yang terkait
   Contoh : Changelog A untuk Perubahan Versi A
4. Versi yang terakhir harus ditulis di paling atas
   Jadi catatan perubahan terbaru harus di letakan pada bagian paling atas, dari catatan perubahan sebelumnya.
5. Kapan perubahan dilakukan wajib di catat
   Tanggal, atau Waktu perubahan harus masuk kedalam catatan
6. Berikan informasi Versi Rilis
   Kamu bisa memberikan informasi versi rilis project dengan menggunakan format Semantic Versioning

B. Daftar Kategori Perubahan

Added       : Fitur Baru
Changed     : Perubahan pada fitur yang telah ada
Deprecated  : Fitur yang akan dihapus dalam waktu dekat
Removed     : Fitur yang telah dihapus
Fixed        : Fitur atau bugs yang telah diperbaiki
Unreleased  : Catatan perubahan yang akan datang.
Security    : Informasi celah keamanan

Contoh Changelog

# Changelog
All notable changes to this project will be documented in this file.

## [1.0.0] - 2022-08-08
### Added
- New Login and Register System
- New Notification after Send Messages
- Indonesian Language Translation

### Changed
- Merge to Bootstrap 5.2

### Removed
- Share button removed due to problem

Demikian Artikel Tentang Apa itu Changelog? Manfaat, dan Cara Membuatnya, jika ada kesalahan dalam penggunakan kata maupun kalimat, saya mohon maaf. Semoga bermanfaat dan terima kasih. 😊🙏

Referensi :

• keepachangelog untuk Referensi
• Semver untuk Referensi
• Flaticon untuk Gambar Icon