Cara Membuat Changelog Untuk Software Development

Ketika kita mengembangkan sebuah aplikasi terkadang kita harus mengubah source code aplikasi tersebut entah karena perbaikan bug atau penambahan fitur. Beberapa file source code yang kita ubah pasti mengalami perubahan dari versi pertama ketika rilis. Dikemudian hari sering kita lupa file-file mana saja yang dulu kita revisi dan kapan kita merevisinya.

Di sinilah changelog (atau log perubahan) berperan. Changelog bertindak sebagai jembatan antara versi produk perangkat lunak kita saat ini dan versi sebelumnya. Jika ditulis secara efektif, alat canggih ini dapat membangun kredibilitas dan kepercayaan di antara anggota tim serta pelanggan. Pentingnya changelogs dapat dilihat pada solusi open source yang dikembangkan oleh sekelompok pengembang di seluruh dunia.

Pengertian dan Tujuan Changelog

Mungkin kita pernah mendengar istilah “changelog” tetapi tidak yakin apa itu. Sederhananya, changelog adalah catatan terdokumentasi dari semua perubahan yang dialami perangkat lunak. Perubahan yang dilakukan kemudian dicatat secara kronologis agar pengguna dapat dengan mudah melihat evolusi produk. Mengikuti format log perubahan yang ditentukan dapat membantu melacak perubahan yang dilakukan secara sistematis, dan membantu kontributor mengidentifikasi perubahan penting dengan mudah.

Perbedaan Changelog dan Release Note

Tanpa contoh changelog yang tepat untuk dirujuk, pengguna mungkin bingung dengan catatan rilis. Tapi keduanya tidaklah sama.

Release note atau catatan rilis adalah dokumen yang memberikan deskripsi panjang lebar tentang rilis versi baru untuk suatu layanan atau produk. Dokumen ini biasanya berisi informasi rinci tentang perubahan yang dilakukan serta dampaknya terhadap pengguna akhir. Catatan tersebut juga mencakup perbaikan bug, dan dalam kasus perangkat lunak sumber terbuka. Catatan rilis bahkan dapat berfungsi sebagai panduan pengguna.

Sedangkan changelog singkat dan langsung pada sasaran. Changelog adalah daftar penambahan, penghapusan & perubahan pada perangkat lunak. Mereka lebih berarti bagi tim yang mengembangkan perangkat lunak dibandingkan pelanggan. Terkadang, mereka juga berisi beberapa detail teknis yang tidak relevan bagi pengguna akhir seperti detail perbaikan bug.

Dengan kata lain, catatan rilis menggunakan bahasa yang lebih komprehensif untuk menjelaskan apa yang telah berubah atau belum berubah dan log perubahan mencantumkan perubahan penting yang dibuat dengan cara yang tidak terlalu bertele-tele & lebih berorientasi teknis: perubahan tersebut dapat dihasilkan dengan bantuan alat log perubahan, seperti catatan rilis .

Jenis-Jenis Changelog

Secara garis besar changelog dapat dibagi menjadi dua jenis yaitu changelog untuk developer (pengembang) dan changelog untuk user (pengguna) .

1. Changelog untuk Developer

Changelog untuk pengembang berisi informasi perubahan-perubahan yang terjadi pada aplikasi namun dari sisi teknis. Log tersebut biasanya menjelaskan file-file apa saja yang telah direvisi beserta pengaruhnya terhadap fitur. Biasanya untuk changelog yang lebih rinci dijelaskan juga perubahan file beserta baris berapa saja yang dirubah. Berikut adalah contoh changelog untuk developer.

27 September 2023 :
-------------------------------------------------------------------------
1. Tidak bisa autofill data barang saat input data barang masuk.
2. Menampilkan ID barang beserta nama barang saat input data barang keluar.
   - Copy dan replace file barang_masuk_form.php ke folder application/views/barang_masuk
   - Copy dan replace file Barang_masuk.php ke folder application/controllers
   - Copy dan replace file Barang_masuk_model.php ke folder application/models
   - Copy dan replace file barang_keluar_form.php ke folder application/views/barang_keluar


26 September 2023 :
-------------------------------------------------------------------------
1. Gambar tidak muncul pada Data Barang
2. Uplad Foto barang tidak masuk ke file dan database
   - Buat Folder image/barang di folder root
   - Copy dan Replace file application/controllers/Barang.php
   - Copy dan Replace file application/views/barang/barang_list.php


18 September 2023 :
-------------------------------------------------------------------------
1. Error pada pagination, Copy dan Replace file berikut :
   - application/controllers/Barang.php
   - application/controllers/Jenis_barang.php
   - application/controllers/Merk_barang.php
   - application/controllers/Supplier.php
   - application/controllers/Barang_masuk.php
   - application/controllers/Barang_keluar.php
   - application/views/barang/barang_list.php
   - application/views/jenis_barang/jenis_barang_list.php
   - application/views/merk_barang/merk_barang_list.php
   - application/views/supplier/supplier_list.php
   - application/views/barang_masuk/barang_masuk_list.php
   - application/views/barang_keluar/barang_keluar_list.php

2. Changelog untuk User

Catatan perubahan untuk level pengguna hanya berisi informasi penting berkaitan dengan perbaikan bug, penambahan, penghapusan atau pembaruan fitur saja. Tidak ada informasi teknis pada catatan perubahan jenis ini. Berikut adalah contoh changelog untuk user.

Version 1.0.3 – 22 June 2023
-------------------------------------------
update - compatible with kmrs version 1.0.8
fixed - RTL to use language rtl options
remove - RTL button on header menu
update - addon min and maximum selection
update - commission/merchant earnings computations
update - session to local storage for user login

Version 1.0.2 – 15 April 2023
--------------------------------------------
new - upload profile photo
new - RTL
new - add options to make addon as checkbox instead of image
fixed - forgot password
fixed - remove address when merchant has no delivery services
fixed - remove address in checkout page if transaction type is not delivery
fixed - language bar on top when mobile view
fixed - multi options addons limit

Version 1.0.1 – 17 January 2023
---------------------------------------------
fixed - issue in product page not showing addons and ingredients
fixed - issue on facebook login
fixed - issue on tax missing
fixed - add to favorites if not login
fixed - paypal payment decimal
fixed - tips showing even disabled in merchant panel
fixed - if has no banner uploaded
fixed - make banner clicikable
fixed - tracking link for single app
fixed - reviews not showing anonymous
fixed - check if merchant is open
fixed - service list by merchant
fixed - out of range when changing transaction type
fixed - multiple transaction list 
fixed - forgot password
fixed - download PDF
fixed - add language code for captcha
fixed - custom page
new - item to be open as popup
new  - require cooking reference
new - pre selected ingredients
new - item not for sale
new - mapbox
new - cash change
new - cash maximum amount
new - table reservations
new - about us page
new - tips percentage or fixed
new - localization or translation

Version 1.0.0 – 16 May 2022
---------------------------------------------
- Initial Release.

Apa saja isi Changelog ?

Berdasarkan kategori perubahan isi changelog terdapat 4 item perubahan, yaitu :

New / Penambahan : berupa informasi penambahan fitur atau ada yang baru di fitur.
Fixed / Perbaikan : berupa informasi perbaikan bugs atau error pada aplikasi.
Update / Pembaruan : berupa informasi perubahan pada fitur aplikasi.
Revome / Penghapusan : berupa informasi penghapusan beberapa fitur pada aplikasi.