Back to Home

Keep a Changelog

Keep a Changelog

This document details best practices for creating and maintaining a changelog, a chronologically ordered list of notable project changes. It emphasizes human readability and recommends using a consistent format (like Keep a Changelog) with categorized changes (added, changed, removed, fixed). The guide discourages using raw git logs and highlights the importance of including deprecations and yanked releases. It also provides examples of good and bad changelog practices, addressing common questions and offering guidance on reducing maintenance effort. Finally, it encourages community contributions to refine the proposed standard.

1
💬0
👁️0
🔗0
Actions

Comments

0
✨ Markdown is supported
💬

No comments yet. Be the first to comment!