Skip to content

Commit 1bd1e64

Browse files
Crunchyman-ralphcoderabbitai[bot]
Crunchyman-ralph
and
coderabbitai[bot]
authored
feat: add pull request templates for bug fixes, features, and integrations (#1044)
* feat: add pull request templates for bug fixes, features, and integrations - Introduced a comprehensive pull request template structure to streamline contributions. - Added specific templates for bug fixes, new features, and integrations to enhance clarity and consistency in PR submissions. - Configured the pull request template settings for better user guidance during the contribution process. * chore: fix format * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * chore: implement PR requested changes --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent dc44ed9 commit 1bd1e64

5 files changed

Lines changed: 197 additions & 0 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# What type of PR is this?
2+
<!-- Check one -->
3+
4+
- [ ] 🐛 Bug fix
5+
- [ ] ✨ Feature
6+
- [ ] 🔌 Integration
7+
- [ ] 📝 Docs
8+
- [ ] 🧹 Refactor
9+
- [ ] Other:
10+
## Description
11+
<!-- What does this PR do? -->
12+
13+
## Related Issues
14+
<!-- Link issues: Fixes #123 -->
15+
16+
## How to Test This
17+
<!-- Quick steps to verify the changes work -->
18+
```bash
19+
# Example commands or steps
20+
```
21+
22+
**Expected result:**
23+
<!-- What should happen? -->
24+
25+
## Contributor Checklist
26+
27+
- [ ] Created changeset: `npm run changeset`
28+
- [ ] Tests pass: `npm test`
29+
- [ ] Format check passes: `npm run format-check` (or `npm run format` to fix)
30+
- [ ] Addressed CodeRabbit comments (if any)
31+
- [ ] Linked related issues (if any)
32+
- [ ] Manually tested the changes
33+
34+
## Changelog Entry
35+
<!-- One line describing the change for users -->
36+
<!-- Example: "Added Kiro IDE integration with automatic task status updates" -->
37+
38+
---
39+
40+
### For Maintainers
41+
42+
- [ ] PR title follows conventional commits
43+
- [ ] Target branch correct
44+
- [ ] Labels added
45+
- [ ] Milestone assigned (if applicable)

‎.github/PULL_REQUEST_TEMPLATE/bugfix.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## 🐛 Bug Fix
2+
3+
### 🔍 Bug Description
4+
<!-- Describe the bug -->
5+
6+
### 🔗 Related Issues
7+
<!-- Fixes #123 -->
8+
9+
### ✨ Solution
10+
<!-- How does this PR fix the bug? -->
11+
12+
## How to Test
13+
14+
### Steps that caused the bug:
15+
1.
16+
2.
17+
18+
**Before fix:**
19+
**After fix:**
20+
21+
### Quick verification:
22+
```bash
23+
# Commands to verify the fix
24+
```
25+
26+
## Contributor Checklist
27+
- [ ] Created changeset: `npm run changeset`
28+
- [ ] Tests pass: `npm test`
29+
- [ ] Format check passes: `npm run format-check`
30+
- [ ] Addressed CodeRabbit comments
31+
- [ ] Added unit tests (if applicable)
32+
- [ ] Manually verified the fix works
33+
34+
---
35+
36+
### For Maintainers
37+
- [ ] Root cause identified
38+
- [ ] Fix doesn't introduce new issues
39+
- [ ] CI passes

‎.github/PULL_REQUEST_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🐛 Bug Fix
4+
url: https://github.com/eyaltoledano/claude-task-master/compare/next...HEAD?template=bugfix.md
5+
about: Fix a bug in Task Master
6+
- name: ✨ New Feature
7+
url: https://github.com/eyaltoledano/claude-task-master/compare/next...HEAD?template=feature.md
8+
about: Add a new feature to Task Master
9+
- name: 🔌 New Integration
10+
url: https://github.com/eyaltoledano/claude-task-master/compare/next...HEAD?template=integration.md
11+
about: Add support for a new tool, IDE, or platform

‎.github/PULL_REQUEST_TEMPLATE/feature.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## ✨ New Feature
2+
3+
### 📋 Feature Description
4+
<!-- Brief description -->
5+
6+
### 🎯 Problem Statement
7+
<!-- What problem does this feature solve? Why is it needed? -->
8+
9+
### 💡 Solution
10+
<!-- How does this feature solve the problem? What's the approach? -->
11+
12+
### 🔗 Related Issues
13+
<!-- Link related issues: Fixes #123, Part of #456 -->
14+
15+
## How to Use It
16+
17+
### Quick Start
18+
```bash
19+
# Basic usage example
20+
```
21+
22+
### Example
23+
<!-- Show a real use case -->
24+
```bash
25+
# Practical example
26+
```
27+
28+
**What you should see:**
29+
<!-- Expected behavior -->
30+
31+
## Contributor Checklist
32+
- [ ] Created changeset: `npm run changeset`
33+
- [ ] Tests pass: `npm test`
34+
- [ ] Format check passes: `npm run format-check`
35+
- [ ] Addressed CodeRabbit comments
36+
- [ ] Added tests for new functionality
37+
- [ ] Manually tested in CLI mode
38+
- [ ] Manually tested in MCP mode (if applicable)
39+
40+
## Changelog Entry
41+
<!-- One-liner for release notes -->
42+
43+
---
44+
45+
### For Maintainers
46+
47+
- [ ] Feature aligns with project vision
48+
- [ ] CIs pass
49+
- [ ] Changeset file exists

‎.github/PULL_REQUEST_TEMPLATE/integration.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# 🔌 New Integration
2+
3+
## What tool/IDE is being integrated?
4+
5+
<!-- Name and brief description -->
6+
7+
## What can users do with it?
8+
9+
<!-- Key benefits -->
10+
11+
## How to Enable
12+
13+
### Setup
14+
15+
```bash
16+
task-master rules add [name]
17+
# Any other setup steps
18+
```
19+
20+
### Example Usage
21+
22+
<!-- Show it in action -->
23+
24+
```bash
25+
# Real example
26+
```
27+
28+
### Natural Language Hooks (if applicable)
29+
30+
```
31+
"When tests pass, mark task as done"
32+
# Other examples
33+
```
34+
35+
## Contributor Checklist
36+
37+
- [ ] Created changeset: `npm run changeset`
38+
- [ ] Tests pass: `npm test`
39+
- [ ] Format check passes: `npm run format-check`
40+
- [ ] Addressed CodeRabbit comments
41+
- [ ] Integration fully tested with target tool/IDE
42+
- [ ] Error scenarios tested
43+
- [ ] Added integration tests
44+
- [ ] Documentation includes setup guide
45+
- [ ] Examples are working and clear
46+
47+
---
48+
49+
## For Maintainers
50+
51+
- [ ] Integration stability verified
52+
- [ ] Documentation comprehensive
53+
- [ ] Examples working

0 commit comments

Comments
 (0)