← Corpus / astro-knots / reminder
Write a Changelog Prior to Meaningful Commits
A quick reference for writing a changelog prior to meaningful commits.
- Path
- reminders/Write-a-Changelog-Prior-to-Meaningful-Commits.md
- Authors
- Michael Staton
- Tags
- Tech-Stack · Astro · Svelte · Tailwind · Preferences
Our Commit and Ship Workflow
For our commit and ship workflow,
Prior to making any meaningful commits,
- the AI Assistant will write a robust changelog consistent with the patterns in the existing changelog. AI Assistants MUST follow frontmatter YAML patterns in order for builds and renders to work properly.
- After the changelog is written, I run a command to generate a companion image to changelog.
- Then, you stage and commit with a robust, easy to understand commit message and commit.
- The commit message should be descriptive and easy to understand
- The commit message should uncomment git’s default comment out of the files changed, so the commit message preserves that information.
- It’s helpful to share the intended commit message with the user before committing. Though, sometimes the user is multi-tasking so they may not respond right away. It is safe to commit if the user does not respond.
- Then the user pushes the commit to the remote repository.