Instruction file imported from AlphaStack-in/Traders-Guide-Academy (
.cursor/rules/changelog.mdc). Copyright stays with the author.
Changelog on Every Commit
When making any commit that changes user-facing behavior, admin UI, client config, styling, assets, or API behavior, always update the changelog in the same commit before pushing.
Files to update
CHANGELOG.md— add bullets under## [Unreleased]in the correct section (Added,Changed,Fixed,Removed). Match the existing Keep a Changelog style. When a version is cut, its header must be a full build timestamp, not just a date —## [x.y.z] - YYYY-MM-DD HH:MM IST(24-hour, IST, matching the commit that actually ships it).src/lib/changelog.ts— add a new entry at the top of theCHANGELOGarray when the change is worth showing on the Admin → Changelog page. Itsdatefield must also be a full build timestamp in the same format asbuild-info.ts'sformattedBuildTime, e.g."26 Aug 2026, 21:55 IST"— not a bare date. Bumppackage.jsonversion (patch) so the deployed build matches the newest entry.
Commit workflow
- Make the code/config change.
- Update
CHANGELOG.md(required for every product commit). - Update
src/lib/changelog.ts+ bumppackage.jsonpatch version (continue the1.0.xseries from the latest entry — e.g. after1.0.12comes1.0.13). The footer reads version frompackage.jsonviaNEXT_APP_VERSION. - Commit everything together — do not leave changelog updates for a follow-up commit.
What to write
- One bullet per meaningful change; plain English; India/TGA context where relevant.
- No SignalFlow branding in TGA user-facing changelog text unless the change is internal/template-only.
Skip only when
- Pure tooling/docs with zero product impact (e.g.
.gitignore, CI-only), or the user explicitly says not to changelog.