Skip to content

🤖 docs: add PR title structure guidelines to AGENTS.md #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2025
Merged

🤖 docs: add PR title structure guidelines to AGENTS.md #463

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c43e2ac
docs: add PR title structure guidelines to AGENTS.md
ammar-agent Oct 28, 2025
0315216
fix: apply prettier formatting to AGENTS.md
ammar-agent Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,24 @@ were created fresh each time. Moved to module scope for stable references.
Verify with React DevTools Profiler - MarkdownCore should only re-render when content changes.
```

### PR Title Structure

Use these prefixes based on what best describes the PR:

- **perf:** (improvement to performance, no functionality changes)
- **refactor:** (improvement to codebase, no behavior changes)
- **fix:** (conforming behavior to user expectations)
- **feat:** (net new functionality)
- **ci:** (concerned with build process or CI)

Examples:

- `🤖 perf: cache markdown plugin arrays to avoid re-parsing`
- `🤖 refactor: extract IPC handlers to separate module`
- `🤖 fix: handle workspace rename edge cases`
- `🤖 feat: add keyboard shortcuts for workspace navigation`
- `🤖 ci: update wait_pr_checks script timeout`

## Project Structure

- `src/main.ts` - Main Electron process
Expand Down