summaryrefslogtreecommitdiff
path: root/.github/prompts/document-changes.prompt.md
blob: 215389cad4db2c0334e6b60868a8c68c393559c4 (plain)
1
2
3
4
5
6
7
8
9
10
---
description: Analyzes the recent workspace changes to update documentation, CHANGELOG, and generate a commit message.
---

Please review the current workspace changes or diffs and perform the following tasks sequentially:

1. **Analyze Changes**: Review the modified files and understand the scope of the updates.
2. **Update README**: Check if the changes affect the project structure, run instructions, or architecture described in `readme.md`. If so, update `readme.md` to reflect these changes.
3. **Update CHANGELOG**: Modify `CHANGELOG.md` to include these changes under the `[Unreleased]` section following the Keep a Changelog format (Added, Changed, Deprecated, Removed, Fixed, Security).
4. **Suggest Commit Message**: Provide a clear, concise commit message summarizing the changes, optionally formatted with Conventional Commits specifications (e.g., `feat: ...`, `fix: ...`, `docs: ...`).