guidelines git_specification changelogging

Changelogging for Worldbuilding

Introduction

Why was this made and Why should this be used?

NOTES for release notes

release notes is the summary of changelog as paragraph

Summary

Release headings MUST contain the version and ISO date.

The Changelog categories MUST appear in the following order. Items within categories with defined order are RECOMMENDDED to follow those order, without creating additional headings:

1. Retcons
   Existing canon is replaced, contradicted, or rewritten.

2. Changed
   Existing canon is modified without becoming a retcon. Item order:

   1. Expansions
      Additional details added.
   2. Clarifications
      Existing ambiguity resolved.
   3. Revisions (aka. other changes)
      Existing information adjusted without contradiction.

3. Canonized
   Previously non-canon material becomes official canon. Item order:

   1. Merging
      Multiple drafts or proposals combined before or during canonization.
   2. Other Canonization
      Draft or proposal formally accepted.

4. Removed
   Existing material is deprecated or removed without heavily altering established canon. Item order:

   1. Deprecations
   2. Removals

5. Drafted
   New non-canon material created or proposed.

6. Miscellaneous
   Changes that do not directly affect worldbuilding content, such as tools, templates, formatting, metadata, or workflow improvements.

Full Spec