Skip to content

Changelog - YYYY-MM-DD

[Main Title/Focus Area]

New Feature Enhancement Bug Fix Security Breaking Change

In one line. [One plain sentence: what this release is, for a user.]

What changed

  • [Thing 1]. [One crisp point in plain language - what changed, not the internal how.]
  • [Thing 2]. [One crisp point in plain language.]
  • [Thing 3]. [One crisp point in plain language.]

Who is affected

  • [Audience or situation 1]. [Are they impacted, and do they need to act? Say "No action needed" where true.]
  • [Audience or situation 2]. [Are they impacted, and do they need to act?]

Breaking changes

WARNING

[One sentence: who this affects and why.]

Before:

typescript
// Code that no longer works

After:

typescript
// New pattern
  1. [Step one]
  2. [Step two]

Details

  • [Why/how point 1]
  • [Why/how point 2]
typescript
// Example usage, if it helps
FilePackage
src/path/to/file.tscore