Skip to content

🤖 docs: add plan file template to PR attribution guidelines #1080

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

Open
ThomasK33 wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Open

🤖 docs: add plan file template to PR attribution guidelines #1080

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,21 @@ description: Agent instructions for AI assistants working on the mux codebase
- `mux`: Electron + React desktop app for parallel agent workflows; UX must be fast, responsive, predictable.
- Minor breaking changes are expected, but critical flows must allow upgrade↔downgrade without friction; skip migrations when breakage is tightly scoped.
- Public work (issues/PRs/commits) must use 🤖 in the title and include "_Generated with `mux`_" in the body when applicable.
- If a plan file exists and is relevant to the PR (i.e., it describes what was implemented), include it in the PR description to help reviewers understand the agent's goals:

```markdown
---

<details>
<summary>📋 Implementation Plan</summary>

CONTENTS OF THE PLAN FILE

</details>

---
_Generated with `mux`_
```

## PR + Release Workflow

Expand Down