Structure human-readable release notes for a maintained project.
Visit website (opens in a new tab)Structure human-readable release notes for a maintained project.
Keep this reference available while working, and test the guidance against the actual requirements of your project.
Find the relevant topic. Use the official reference to locate the concept you are working on.
Read the context. Review definitions, examples and any version or compatibility notes.
Apply and verify. Adapt the guidance to your project and test the result.
Ready to try it?
Open Keep a Changelog (opens in a new tab)