mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-04-01 07:27:46 +00:00
76901ba22f
Requested by @majdyz ### Why / What / How **Why:** PR descriptions currently explain the *what* and *how* but not the *why*. Without motivation context, reviewers can't judge whether an approach fits the problem. Nick flagged this in standup: "The PR descriptions you use are explaining the what not the why." **What:** Adds a consistent Why / What / How structure to PR descriptions across the entire workflow — template, CLAUDE.md guidance, and all PR-related skills (`/pr-review`, `/pr-test`, `/pr-address`). **How:** - **`.github/PULL_REQUEST_TEMPLATE.md`**: Replaced the old vague `Changes` heading with a single `Why / What / How` section with guiding comments - **`autogpt_platform/CLAUDE.md`**: Added bullet under "Creating Pull Requests" requiring the Why/What/How structure - **`.claude/skills/pr-review/SKILL.md`**: Added "Read the PR description" step before reading the diff, and "Description quality" to the review checklist - **`.claude/skills/pr-test/SKILL.md`**: Updated Step 1 to read the PR description and understand Why/What/How before testing - **`.claude/skills/pr-address/SKILL.md`**: Added "Read the PR description" step before fetching comments ## Test plan - [x] All five files reviewed for correct formatting and consistency --- Co-authored-by: Zamil Majdy (@majdyz) <zamil.majdy@agpt.co>
1.6 KiB
1.6 KiB
Why / What / How
Changes 🏗️
Checklist 📋
For code changes:
- I have clearly listed my changes in the PR description
- I have made a test plan
- I have tested my changes according to the test plan:
- ...
Example test plan
- Create from scratch and execute an agent with at least 3 blocks
- Import an agent from file upload, and confirm it executes correctly
- Upload agent to marketplace
- Import an agent from marketplace and confirm it executes correctly
- Edit an agent from monitor, and confirm it executes correctly
For configuration changes:
.env.defaultis updated or already compatible with my changesdocker-compose.ymlis updated or already compatible with my changes- I have included a list of my configuration changes in the PR description (under Changes)
Examples of configuration changes
- Changing ports
- Adding new services that need to communicate with each other
- Secrets or environment variable changes
- New or infrastructure changes such as databases