Skip to content

Latest commit

 

History

History
92 lines (54 loc) · 5.76 KB

CHANGELOG.md

File metadata and controls

92 lines (54 loc) · 5.76 KB

Changelog template

{If you need more information about how to fill in this template, read the accompanying changelog template guide.}

{This template includes writing instructions and boilerplate text that you can customize, use as-is, or completely replace with your own text. This text is indicated in {curly brackets}. Make sure you replace the placeholders with your own text.}

{MAJOR.MINOR.PATCH} - {YYYY-MM-DD}

{The version number should be listed first. You should use Semantic Versioning (SemVer) for the version number and International Date Format ISO 8601 for the date.}

Release highlights

{Use this section to provide an overview of the most important changes in this release. This section should be a bulleted list.}

  • {Feature Name}: {Summary}
  • {Feature Name}: {Summary}
  • {Feature Name}: {Summary}

Added

{Use this section to list any new features that have been added since the last release. If you build your changelog from Git commits, the feature description and commit number will be added automatically.}

{Start each description with a verb, such as "Fixed", "Improved", or "Added."}

{Replace "Commit number" with the commit number for the feature. Remember to update the link text for the commit and contributor handle.}

Changed

{Use this section to list changes in existing functionality for your application. If you build your changelog from Git commits, the feature description and commit number will be added automatically.}

{Start each description with a verb, such as "Fixed", "Improved", or "Added."}

{Replace "Commit number" with the commit number for the feature. Remember to update the link text for the commit and contributor handle.}

Deprecated

{Use this section to list features that were deprecated for the release. If you build your changelog from Git commits, the feature description and commit number will be added automatically.}

{Start each description with a verb, such as "Fixed", "Improved", or "Added."}

{Replace "Commit number" with the commit number for the feature. Remember to update the link text for the commit and contributor handle.}

Fixed

{Use this section to highlight bugs that were fixed during the release. If you build your changelog from Git commits, the feature description and commit number will be added automatically.}

{Start each description with a verb, such as "Fixed", "Improved", or "Added."}

{Replace "Commit number" with the commit number for the feature. Remember to update the link text for the commit and contributor handle.}

Security

{Use this section to list any resolved common vulnerabilities and exposures (CVEs) or other improvements to your software's security. If you build your changelog from Git commits, the feature description and commit number will be added automatically.}

{Start each description with a verb, such as "Fixed", "Improved", or "Added."}

{Replace "Commit number" with the commit number for the feature. Remember to update the link text for the commit and contributor handle.}

Breaking changes

{Use this section to list any breaking changes to your software. If you build your changelog from Git commits, the feature description and commit number will be added automatically.}

{Start each description with a verb, such as "Fixed", "Improved", or "Added."}

{Replace "Commit number" with the commit number for the feature. Remember to update the link text for the commit and contributor handle.}