-
Type:
Task
-
Resolution: Unresolved
-
Priority:
Major - P3
-
None
-
Affects Version/s: None
-
Component/s: Infrastructure
-
None
Context
Our changelog entries don't follow a documented style. Contributors currently guess at tense, wording, and formatting, which leads to inconsistent entries across drivers and over time.
Definition of done
A written style guide based on "Keep a Changelog" (https://keepachangelog.com) exists for changelog entries that defines tense, voice, level of detail, how to reference tickets/PRs, date format, ordering, etc.
This style guide should be added to our CONTRIBUTING.md and titled "Changelog Standards"
Pitfalls
Agreeing on the contents of the guide and where to publish the guide.