THE GITHTML FIELD GUIDE
Review AI-generated release notes against shipped behavior
AI-generated release notes need a release-specific review, not just proofreading. Confirm that every entry shipped in the identified version, describes a meaningful user effect, and preserves important limitations. Remove internal details and unsupported performance claims, and check required actions against the actual migration documentation before publishing.
Give the draft a precise release boundary
Define the base and target revisions or the project's authoritative release range. A merged change may have been reverted, withheld, or released elsewhere, so a list of recent commits is not sufficient. An illustrative export preview feature should appear in the notes only if it is actually available to the intended audience. Keep a Changelog distinguishes curated change history from raw development activity. Use the generator to propose readable entries from approved evidence, not to decide what the organization has released.
Review the impact claim in each entry
Check the affected task, audience, platform, and availability. A draft may turn an internal cleanup into a new capability or describe a narrow bug fix as universal reliability improvement. An illustrative correction could replace uploads are now instant with validation messages appear before confirmation, if that is what the verified change establishes. Do not add numbers without a documented measurement. Review links and issue references for public suitability, and remove customer names, private incident details, or security-sensitive explanations that are not approved for disclosure.
- Shipping check: confirm the entry belongs to this release and audience.
- Meaning check: explain the observable change without invented benefits.
- Action check: verify migration requirements and known limitations against their source.
Keep editorial approval distinct from generation
Assign someone who understands release scope to approve the final wording. Record unresolved availability questions rather than letting a generator choose confident language. Ensure the summary and headline do not exaggerate what the detailed entries say. Preserve the version, date, and historical link when rendering the notes as HTML. Users may read an older snapshot later, so avoid relative phrases such as today or next week when an exact date is known. gitHtml can display the committed release document, but it neither assembles releases nor publishes generated notes automatically.
Sources and further reading
AI-assisted writing with source-linked guidance and illustrative examples. Read our editorial approach or report a correction.