3
deck
What is a CHANGELOG?
A CHANGELOG is a document that summarizes the changes made to a project.
It typically includes the following:
- Addition of new features
- Modifications to existing features
- Bug fixes
Common English Expressions Related to CHANGELOG
| Expression | Meaning |
|---|---|
add a new feature | Introduce new functionality to the software |
fix a bug | Correct an error or issue in the code |
update a dependency | Change to a newer version of an external library or package |
remove unused code | Delete code that is no longer needed or used |
refactor the logic | Improve the structure of code without changing its behavior |
deprecate a feature | Mark a feature as outdated and discourage its future use |
release a new version | Officially publish a new version of the software |
document the API | Write or update documentation explaining how the API works |
===
Example of a CHANGELOG.md Document
## [1.2.0] - 2024-05-10
### Added
- Support for dark mode in user settings
- New API endpoint for retrieving user stats
### Fixed
- Crash when uploading large images
- Alignment issue on mobile dashboard
### Changed
- Updated dependencies to latest versions
- Organize entries by type of change.
- Write items in concise and consistent sentences.
Tips for Writing a CHANGELOG
- Write entries in a single, concise line.
- Group similar types of changes together.
- Use a consistent format for dates and version numbers.
- The file is commonly named
CHANGELOG.md.
===
Want to learn more?
Join CodeFriends Plus membership or enroll in a course to start your journey.