mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-04 21:00:40 +08:00
feat: add pull request template
This commit is contained in:
48
PULL_REQUEST_TEMPLATE.md
Normal file
48
PULL_REQUEST_TEMPLATE.md
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
## 📌 Pull Request Template
|
||||||
|
|
||||||
|
### 1️⃣ Short Description
|
||||||
|
<!-- Provide a concise summary of the changes in this PR. -->
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2️⃣ Related Open Issue
|
||||||
|
<!-- Link the related issue(s) this PR is addressing, e.g., Fixes #123 or Closes #456. -->
|
||||||
|
Fixes #
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3️⃣ PR Type
|
||||||
|
<!-- Select one of the following by marking `[x]` -->
|
||||||
|
|
||||||
|
- [ ] 🐞 Bug Fix
|
||||||
|
- [ ] ✨ New Feature
|
||||||
|
- [ ] 🔄 Refactoring
|
||||||
|
- [ ] 📖 Documentation Update
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4️⃣ Does this PR Introduce a Breaking Change?
|
||||||
|
<!-- Mark the applicable option -->
|
||||||
|
- [ ] ❌ No
|
||||||
|
- [ ] ⚠️ Yes (Explain below)
|
||||||
|
|
||||||
|
If **yes**, describe the impact and necessary migration steps:
|
||||||
|
<!-- Provide a short explanation of what needs to be changed. -->
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5️⃣ Current Behavior (Before Changes)
|
||||||
|
<!-- Describe the existing behavior before applying the changes in this PR. -->
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 6️⃣ New Behavior (After Changes)
|
||||||
|
<!-- Explain how the behavior changes with this PR. -->
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ✅ Checklist
|
||||||
|
- [ ] Code follows the project's coding guidelines.
|
||||||
|
- [ ] Tests have been added or updated (if applicable).
|
||||||
|
- [ ] Documentation has been updated (if applicable).
|
||||||
|
- [ ] Ready for review and approval.
|
Reference in New Issue
Block a user