Skip to content

Commit 5db27e7

Browse files
docs(agents): tighten release notes guidance with do/don't examples
Add explicit length constraints (bold name: 2-4 words, description: one sentence ~10-15 words) and concrete do/don't comparisons to prevent verbose multi-sentence release notes. Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
1 parent 0819911 commit 5db27e7

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,7 @@ Follow this exact format:
142142

143143
```markdown
144144
## What's New
145-
- **Feature name** — One sentence user-facing description (`openboot <command>`)
146-
- **Feature name** — One sentence user-facing description
145+
- **Feature name** — One sentence, user-facing benefit only (`openboot <command>`)
147146

148147
## Improvements
149148
- **Area** — What changed and why users care
@@ -169,10 +168,21 @@ curl -fsSL https://openboot.dev/install | bash
169168

170169
- Omit empty sections (no "Bug Fixes" if there are none)
171170
- Write for **users**, not developers. No internal refactors, no test-only changes
172-
- Each bullet is one line, starts with **bold name** — description
173-
- Include the CLI command if it's a new/changed command
171+
- **Bold name**: 2–4 words max, noun form. Not a sentence.
172+
- **Description**: ONE sentence, ~10–15 words max. User benefit only — no implementation details, no "how it works".
173+
- Include the CLI command at the end if it's a new/changed command
174174
- Keep Installation and Binaries sections at the bottom (always)
175175

176+
**Do / Don't:**
177+
178+
```
179+
✓ - **Post-install script** — Run custom shell commands after your environment is set up (`openboot -u <user>`)
180+
✗ - **Post-install script** — Run custom shell commands after your environment is set up. Add a post_install array to your config on openboot.dev and each command runs sequentially in your home directory after packages, shell, dotfiles, and macOS preferences are applied.
181+
182+
✓ - **Custom config install** — Shell, dotfiles, and macOS setup now run correctly when installing from a remote config
183+
✗ - **Custom config installs now run shell, dotfiles, and macOS setup** — When installing via openboot -u <user>, shell configuration (Oh-My-Zsh), dotfiles cloning, and macOS preferences were silently skipped. All three steps now run as expected.
184+
```
185+
176186
**Step 3: Update the release on GitHub**
177187

178188
```bash

0 commit comments

Comments
 (0)