Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
53 changes: 36 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
## Summary

<!-- Brief description of what this PR does -->
**REQUIRED: Write 2-4 sentences describing WHAT this PR does and WHY.**

## Changes

**REQUIRED: List the specific changes made in this PR:**
-
-
-

## Type of Change

Expand All @@ -13,36 +20,48 @@

## Testing

<!-- How was this tested? -->
**Describe how this was tested:**

- [ ] Unit tests added/updated
- [ ] Manual testing performed
- [ ] N/A (documentation only)

## Documentation Checklist

<!-- Check all that apply -->
## Documentation

- [ ] **No docs needed** — This change doesn't affect user-facing features
- [ ] **Docs updated** — Help center articles updated to reflect this change
- [ ] **Docs flagged** — This needs doc updates but they're tracked elsewhere (link issue/TODO)

### If docs are affected:

**Which articles need updates?**
<!-- List specific files in docs/help-center/articles/ or docs/legal/ -->

**What changed?**
<!-- Brief description of what documentation needs to say -->
- [ ] **Docs flagged** — This needs doc updates but they're tracked elsewhere

## Checklist

- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code where necessary
- [ ] My changes generate no new warnings
- [ ] Any dependent changes have been merged and published

---

*Remember: Documentation accuracy is a feature. If this PR changes behavior, update the docs.*
<!--
## For AI Agents

When creating a PR, you MUST:

1. **Write a descriptive PR title** using conventional commits format:
- `feat: Add dark mode toggle to settings`
- `fix: Correct timezone handling in scheduler`
- `refactor: Extract validation into shared utility`

2. **Fill in the Summary** with actual content (not placeholders):
- What problem does this solve?
- What was the approach?
- Any important context?

3. **List specific Changes** as bullet points:
- Be specific: "Add `validateEmail()` function to auth module"
- Not vague: "Update files"

4. **Check the appropriate Type of Change** checkbox

5. **Describe Testing** - what did you do to verify this works?

DO NOT leave HTML comments as placeholders. Replace ALL template text with actual content.
-->
50 changes: 49 additions & 1 deletion AGENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ This lesson learned the hard way: the mobile menu z-index fix (#367) only worked

### Git Workflow Essentials

> **⚠️ IMPORTANT:** Before making commits or PRs, invoke the `git-workflows` skill for full guidance.

**After completing major changes, you MUST commit your work.**

**Conventional Commits Format:**
Expand All @@ -177,6 +179,51 @@ docs: Update README

**For complete details:** See `AgentUsage/git_guide.md`

### Pull Request Requirements

**When creating PRs, you MUST write descriptive titles and descriptions.**

**PR Title Format:** Use conventional commits format
```
feat: Add dark mode toggle to settings
fix: Correct timezone handling in scheduler
refactor: Extract validation into shared utility
```

**PR Description Requirements:**
1. **Summary** — 2-4 sentences explaining WHAT and WHY (not placeholders)
2. **Changes** — Specific bullet points of what changed
3. **Type of Change** — Check the appropriate checkbox
4. **Testing** — Describe how you verified it works

**Example good PR description:**
```markdown
## Summary
Adds a dark mode toggle to the settings page, allowing users to switch
between light and dark themes. This addresses user feedback about eye
strain during nighttime use.

## Changes
- Add `ThemeToggle` component to settings page
- Create `useTheme` hook for theme state management
- Update CSS variables for dark mode colors
- Add theme preference to user settings storage

## Type of Change
- [x] New feature

## Testing
- Manually tested toggle in Chrome and Firefox
- Verified theme persists across page reloads
- Checked accessibility contrast ratios in both modes
```

**DO NOT:**
- Leave template placeholders like `<!-- Brief description -->`
- Use vague descriptions like "Update files" or "Fix things"
- Skip the summary section
- Create PRs with empty descriptions

---

## 🌲 Engine-First Pattern (CRITICAL)
Expand Down Expand Up @@ -290,6 +337,7 @@ cat packages/engine/package.json | grep -A2 '"\./'

### Version Control
- **Before making a git commit** → Use skill: `git-workflows`
- **Before creating a pull request** → Use skill: `git-workflows`
- **When initializing a new repo** → Use skill: `git-workflows`
- **For git workflow and branching** → Use skill: `git-workflows`
- **When setting up git hooks** → Use skill: `git-hooks`
Expand Down Expand Up @@ -505,5 +553,5 @@ For in-depth reference beyond what skills provide, see:

---

*Last updated: 2026-01-15*
*Last updated: 2026-01-17*
*Model: Claude Opus 4.5*