Changelog & release notes

Hình như nhiêu người thích viết changelog hay changelogs (không có khoảng trắng) thay vì change logs.

Change logs

(Deprecated) Changelog format của file, mỗi khi có release/deploy hoặc ở source code - CHANGELOG.MD như sau:

# Changelog

Các thay đổi trong dự án phải được ghi ở đây.

Định dạng được dựa trên [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [Unreleased]/1.0.0 - 2024-04-04

### Added

- Liệt kê các tính năng mới.

### Deprecated

- Liệt kê các tính năng đánh dấu, sắp loại bỏ ở phiên bản tương lai.

### Changed

- Liệt các thay đổi trong tính năng đã làm.
- *Nếu tính năng thay đổi gây phá vỡ cấu trúc cũ thì dòng đó in đậm.*

### Removed

- Liệt kê các tính năng bị loại bỏ.

### Fixed

- Liệt kê các vá lỗi tính năng hoặc xử lý vấn đề.

### Security

- Liệt kê các cập nhật về bảo mật.

Changelog cho các tài liệu GitBook:

Trong trang changelog của gitbook thì sẽ có những quy định như sau:

1. Title: Ngày tháng: Mô tả thông tin chính về version

2. Description: Version: a.b.c.d (Tùy theo module quy định version)

3. Body

   Các title chính sẽ viết ở Heading 1, và sẽ bao gồm các giá trị và thứ tự như sau:

Thứ tự	Tiêu đề	Mô tả
1	Added	Liệt kê thêm các tính năng mới.
2	Changed	Những thay đổi của các tính năng, và có những cải tiến ở phiên bảng hiện tại.
3	Fixed	Sửa các lỗi đã có ở phiên bản trước.
4	Deprecated	Những tính năng sẽ được loại bỏ trong tương lai.
5	Removed	Những tính năng đã xóa ở phiên bản hiện tại.

Để hiểu rõ hơn thì xem 1 page ví dụ sau: 27 July: Updates release notes conventions

Luôn nằm cuối cùng (sau Reference luôn), file/page tên là "changelog" và lưu table dạng sau:

STT	Ngày	Tác giả	Ghi chú
1	10-02-2024	Vardy	Khởi tạo tài liệu này.
2	27-07-2024	Steve	Cập nhật lại thông tin release notes trên trang GitBook.

Release notes

Change log là nội bộ trong source code. Còn đối với người dùng thì dùng release-notes. Xem thêm phần quy định về link (URL) release-notes ở mục dành cho FE: URL cho release notes