Skip to content

Commit 646a727

Browse files
authored
🤖 docs: add PR title structure guidelines to AGENTS.md (#463)
Added a new section to AGENTS.md documenting the preferred PR title structure with conventional commit prefixes. **New Guidelines:** - perf: for performance improvements - refactor: for codebase improvements without behavior changes - fix: for bug fixes - feat: for new functionality - ci: for build/CI changes Includes examples showing how to combine prefixes with the 🤖 emoji per existing AI attribution guidelines. _Generated with `cmux`_
1 parent 0e256d4 commit 646a727

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,24 @@ were created fresh each time. Moved to module scope for stable references.
9898
Verify with React DevTools Profiler - MarkdownCore should only re-render when content changes.
9999
```
100100

101+
### PR Title Structure
102+
103+
Use these prefixes based on what best describes the PR:
104+
105+
- **perf:** (improvement to performance, no functionality changes)
106+
- **refactor:** (improvement to codebase, no behavior changes)
107+
- **fix:** (conforming behavior to user expectations)
108+
- **feat:** (net new functionality)
109+
- **ci:** (concerned with build process or CI)
110+
111+
Examples:
112+
113+
- `🤖 perf: cache markdown plugin arrays to avoid re-parsing`
114+
- `🤖 refactor: extract IPC handlers to separate module`
115+
- `🤖 fix: handle workspace rename edge cases`
116+
- `🤖 feat: add keyboard shortcuts for workspace navigation`
117+
- `🤖 ci: update wait_pr_checks script timeout`
118+
101119
## Project Structure
102120

103121
- `src/main.ts` - Main Electron process

0 commit comments

Comments
 (0)