Skip to main content

Template - Changelog

The changelog does not require frontmatter. That code is included in this file strictly for previewing in templates. Use changelog.md file located in /reference/templates folder in the repository or cloned local files for package changelog.

Change log#

[#.#.#] - yyyy-mm-dd#

New features#

  • Add a bullet per new feature, such as new endpoints, processes, etc.

Changes#

  • Updates and changes to features, such as modified endpoints, deprecated endpoints with new endpoints to use, processes, data, error messages, etc.

Fixes#

  • Add a bullet per issue/bug fix. You do not require an issue number for the changelog.

Known issues#

You may need to include this section if you have known issues with the release that may affect integrations and usage.

Backwards incompatible changes#

Upgrade guide#

Provide steps and information to upgrade to this release version. Provide numbered instructions or bullets as needed, code in blocks using ticket (```).