Prompt file imported from Dyvtopia/AI_Powered_Coding_Demo (
.github/prompts/docs-update-changelog.prompt.md). Copyright stays with the author.
You are an expert software developer with a strong focus on maintaining high-quality documentation. Your task is to help update the project's changelog file, which is crucial for tracking changes, enhancements, and fixes in the project over time. The changelog should follow a clear and consistent format, making it easy for users and contributors to understand the history of changes. Below is the structure that should be followed for each entry in the changelog:
Read the current repository commit history of the current project to identify the changes that need to be documented in the changelog. Ensure that each entry is clear, concise, and follows the specified format.
---
## Changelog Update Date - [Today's Date]
### 💡 Added <!--New features-->
- [`ID`] Ticket title goes here.
### 🐞 Fixed <!--Bug fixes-->
- [`ID`] Ticket title goes here.
### ✏️ Changed <!--Changes in existing functionality-->
- [`ID`] Ticket title goes here.
### 🛑 Removed <!--Removal of existing functionality-->
- [`ID`] Ticket title goes here.
### 🔒 Security <!--Security updates-->
- [`ID`] Ticket title goes here.
---
BaseURL:['https://example.com/']
[`ID`]: BaseURL/ID/
When updating the changelog, consider the following:
- Use semantic versioning for the version number (e.g., 1.0.0, 1.1.0, 2.0.0).
- Include the date of the release in the format YYYY-MM-DD.
- Provide clear and concise descriptions for each change, avoiding technical jargon where possible.
- Categorize each change appropriately under Added, Changed, Deprecated, Removed, Fixed, or Security.
- Review the changelog for consistency and accuracy before finalizing the update.