From 44a8f04db97ad6c618153ac45e7ab0a9228c6f47 Mon Sep 17 00:00:00 2001 From: 777genius Date: Sun, 24 May 2026 20:42:54 +0300 Subject: [PATCH] docs(release): document public notes standard --- docs/RELEASE.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 21f47455..dd87624a 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -1,5 +1,9 @@ # Release Guide +## Published: v2.1.2 (2026-05-23) + +Performance and reliability release: faster startup, deferred provider/runtime hydration, resilient file watching under watcher limits, safer context switching, better team launch diagnostics, and packaged app entry/runtime fixes. GitHub release: [v2.1.2](https://github.com/777genius/agent-teams-ai/releases/tag/v2.1.2). + ## Published: v1.2.0 (2026-03-31) Agent Graph, per-team tool approval, interactive AskUserQuestion, task comment notifications, cross-team ghost nodes. Major graph improvements: force-directed visualization with kanban task layout, fullscreen/tab mode, animated particles, member hexagons with avatars, popover actions. Permission system overhaul with proper Write/Edit/NotebookEdit seeding and MCP tool catalog integration. Full list: [CHANGELOG.md](./CHANGELOG.md). @@ -131,6 +135,17 @@ EOF )" ``` +Public release notes must follow this standard every time: + +- Start with a short user-facing summary. Explain what changed and why users should care. +- Do not add a duplicate `## Agent Teams v` heading inside the release body; the GitHub release title already shows the version. +- Use the sections `What's New`, `Improvements`, and `Bug Fixes`; omit a section only if it would be empty. +- Keep internal-only CI, lint, dependency, and refactor work out of public notes unless it directly explains a user-visible fix. +- Put `Downloads` as the final section, after all text notes. +- Use badge/button links in `Downloads`, not bare asset links. +- Verify actual asset names with `gh release view v --repo 777genius/agent-teams-ai --json assets` before writing links. +- Prefer versioned installer links for release-specific notes: `Agent.Teams.AI--arm64.dmg`, `Agent.Teams.AI--x64.dmg`, `Agent.Teams.AI.Setup..exe`, `Agent.Teams.AI-.AppImage`, `agent-teams-ai__amd64.deb`, `agent-teams-ai-.x86_64.rpm`, and `agent-teams-ai-.pacman`. + ### 4. Required release closeout gate Do not publish or call a release finished until this is true: @@ -146,8 +161,6 @@ If a draft was published before notes were written, immediately edit the public ## Release Notes Template ```markdown -## Agent Teams v - <1-2 sentence summary of the release> ### What's New @@ -181,7 +194,9 @@ If a draft was published before notes were written, immediately edit the public Windows
- May trigger SmartScreen — click "More info" → "Run anyway" + May trigger SmartScreen - click "More info" then "Run anyway" +
+ Windows required: launch Agent Teams AI as Administrator, especially when using OpenCode runtimes.