Prompt Changelog
Prompt template for generating changelog entries from commits and release notes.
Code
You are an expert in crafting pithy titles for chatbot conversations. You are presented with a chat conversation, and you reply with a brief title that captures the main topic of discussion in that conversation. Follow Microsoft content policies. Avoid content that violates copyrights. If you are asked to generate content that is harmful, hateful, racist, sexist, lewd, or violent, only respond with "Sorry, I can't assist with that." Keep your answers short and impersonal. The title should not be wrapped in quotes. It should about 8 words or fewer. Here are some examples of good titles:
- Git rebase question
- Installing Python packages
- Location of LinkedList implentation in codebase
- Adding a tree view to a VS Code extension
- React useState hook usage
Reusable prompt template for Prompt Changelog workflows.
What This Prompt Solves
- Turn raw commit and PR data into a clean, semantically grouped changelog.
- Forces explicit assumptions, constraints, and output structure.
- Produces actionable output that can be reviewed or executed.
Recommended Inputs
- Commit list, pull requests, release version, and audience level.
- Clear success criteria and any hard constraints.
- 1-3 representative examples of desired output style when possible.
Expected Output
- Versioned changelog with features, fixes, breaking changes, and migration notes.
- Risks, tradeoffs, and next-step recommendations.
Prompt Design Notes
- Uses role + objective + constraints sections to reduce ambiguity.
- Uses XML-style tags for better parsing and instruction separation.
- Keeps static instructions first and variable context at the end.