Skip to content

Optimize Changelog Tips #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tembo wants to merge 1 commit into from
Closed

Optimize Changelog Tips #295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 4 additions & 15 deletions automations-library/product-changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,7 @@ If no new tag exists, do nothing.

## Tips for Product Changelog Automations

### Be User-Focused

When generating changelogs, focus on the impact to end users rather than technical implementation details. Your customers care about what changed for them, not internal refactoring.

### Use Consistent Formatting

Stick to a consistent format for changelogs across all releases. This makes it easier for users to scan and understand changes quickly.

### Include Version Numbers

Always include version numbers or tags in release notes to help users track which version they're running.

### Link to Documentation

For significant new features, include links to relevant documentation or guides to help users understand how to use the new functionality.
- **Be user-focused**: Focus on impact to users, not technical implementation details
- **Use consistent formatting**: Stick to a format users can quickly scan
- **Include version numbers**: Help users track which version they're running
- **Link to documentation**: Include links to guides for significant new features