Documentation21 categories
Write changelog entries from these commits
Cutting a release and the commit log is not a changelog.
Turn the commits below into a changelog entry written for users, not contributors. Group under: Breaking changes, Added, Changed, Fixed, Deprecated, Security. Omit any empty group. Rules: - Each line describes the effect on the user, not the implementation. If a commit changes nothing a user can observe, leave it out. - Breaking changes come first, and each states what breaks, who is affected, and the migration in one line. - For fixes, describe the symptom the user saw, not the internal cause. - No commit hashes in the prose. Link issue numbers at the end of the line if I supply them. - Merge multiple commits that produced one user-visible change into a single entry. List separately any commit you could not classify, so I can check whether it needed an entry. Version: Commits:
Making it yours
- Paste your own material where the prompt asks for it. Everything above that line is instruction, not content.
- Delete any rule that does not apply to you. A shorter prompt that fits beats a thorough one that does not.
- If the answer comes back vague, add a line saying what you do not want. Constraints work better than encouragement.
Releases and decisions. Changelogs, migration guides and decision records that explain what changed and why.
Related prompts
Write a migration guide for a breaking changeShipping a major version and users have to change their code.Write an architecture decision recordA decision was made in a meeting and will be questioned in a year.Changelog line for this changeOne commit that needs one honest user-facing line.Structure a README that gets someone runningA project with working code and a README that says only its name.Generate API reference from this codeA module whose public surface needs documenting properly, not just typed.Write the doc comment this function deservesA function whose name and types don't tell the whole story.
Keep this one
Phrasery saves prompts with a right-click and puts them back the same way. Add this to your own library in one click.
Add to your browser โ free