From 1bd1e64cacb9304865527ed8fb90a57dc686afda Mon Sep 17 00:00:00 2001 From: Ralph Khreish <35776126+Crunchyman-ralph@users.noreply.github.com> Date: Thu, 24 Jul 2025 18:33:43 +0300 Subject: [PATCH] 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> --- .github/PULL_REQUEST_TEMPLATE.md | 45 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/bugfix.md | 39 ++++++++++++++ .github/PULL_REQUEST_TEMPLATE/config.yml | 11 ++++ .github/PULL_REQUEST_TEMPLATE/feature.md | 49 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/integration.md | 53 ++++++++++++++++++++ 5 files changed, 197 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/bugfix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/integration.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..cef2112a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,45 @@ +# What type of PR is this? + + + - [ ] ๐Ÿ› Bug fix + - [ ] โœจ Feature + - [ ] ๐Ÿ”Œ Integration + - [ ] ๐Ÿ“ Docs + - [ ] ๐Ÿงน Refactor + - [ ] Other: +## Description + + +## Related Issues + + +## How to Test This + +```bash +# Example commands or steps +``` + +**Expected result:** + + +## Contributor Checklist + +- [ ] Created changeset: `npm run changeset` +- [ ] Tests pass: `npm test` +- [ ] Format check passes: `npm run format-check` (or `npm run format` to fix) +- [ ] Addressed CodeRabbit comments (if any) +- [ ] Linked related issues (if any) +- [ ] Manually tested the changes + +## Changelog Entry + + + +--- + +### For Maintainers + +- [ ] PR title follows conventional commits +- [ ] Target branch correct +- [ ] Labels added +- [ ] Milestone assigned (if applicable) diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md new file mode 100644 index 00000000..326247d5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -0,0 +1,39 @@ +## ๐Ÿ› Bug Fix + +### ๐Ÿ” Bug Description + + +### ๐Ÿ”— Related Issues + + +### โœจ Solution + + +## How to Test + +### Steps that caused the bug: +1. +2. + +**Before fix:** +**After fix:** + +### Quick verification: +```bash +# Commands to verify the fix +``` + +## Contributor Checklist +- [ ] Created changeset: `npm run changeset` +- [ ] Tests pass: `npm test` +- [ ] Format check passes: `npm run format-check` +- [ ] Addressed CodeRabbit comments +- [ ] Added unit tests (if applicable) +- [ ] Manually verified the fix works + +--- + +### For Maintainers +- [ ] Root cause identified +- [ ] Fix doesn't introduce new issues +- [ ] CI passes \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/config.yml b/.github/PULL_REQUEST_TEMPLATE/config.yml new file mode 100644 index 00000000..0cc23e61 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: ๐Ÿ› Bug Fix + url: https://github.com/eyaltoledano/claude-task-master/compare/next...HEAD?template=bugfix.md + about: Fix a bug in Task Master + - name: โœจ New Feature + url: https://github.com/eyaltoledano/claude-task-master/compare/next...HEAD?template=feature.md + about: Add a new feature to Task Master + - name: ๐Ÿ”Œ New Integration + url: https://github.com/eyaltoledano/claude-task-master/compare/next...HEAD?template=integration.md + about: Add support for a new tool, IDE, or platform \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md new file mode 100644 index 00000000..e981aa6f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -0,0 +1,49 @@ +## โœจ New Feature + +### ๐Ÿ“‹ Feature Description + + +### ๐ŸŽฏ Problem Statement + + +### ๐Ÿ’ก Solution + + +### ๐Ÿ”— Related Issues + + +## How to Use It + +### Quick Start +```bash +# Basic usage example +``` + +### Example + +```bash +# Practical example +``` + +**What you should see:** + + +## Contributor Checklist +- [ ] Created changeset: `npm run changeset` +- [ ] Tests pass: `npm test` +- [ ] Format check passes: `npm run format-check` +- [ ] Addressed CodeRabbit comments +- [ ] Added tests for new functionality +- [ ] Manually tested in CLI mode +- [ ] Manually tested in MCP mode (if applicable) + +## Changelog Entry + + +--- + +### For Maintainers + +- [ ] Feature aligns with project vision +- [ ] CIs pass +- [ ] Changeset file exists diff --git a/.github/PULL_REQUEST_TEMPLATE/integration.md b/.github/PULL_REQUEST_TEMPLATE/integration.md new file mode 100644 index 00000000..cc44396b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/integration.md @@ -0,0 +1,53 @@ +# ๐Ÿ”Œ New Integration + +## What tool/IDE is being integrated? + + + +## What can users do with it? + + + +## How to Enable + +### Setup + +```bash +task-master rules add [name] +# Any other setup steps +``` + +### Example Usage + + + +```bash +# Real example +``` + +### Natural Language Hooks (if applicable) + +``` +"When tests pass, mark task as done" +# Other examples +``` + +## Contributor Checklist + +- [ ] Created changeset: `npm run changeset` +- [ ] Tests pass: `npm test` +- [ ] Format check passes: `npm run format-check` +- [ ] Addressed CodeRabbit comments +- [ ] Integration fully tested with target tool/IDE +- [ ] Error scenarios tested +- [ ] Added integration tests +- [ ] Documentation includes setup guide +- [ ] Examples are working and clear + +--- + +## For Maintainers + +- [ ] Integration stability verified +- [ ] Documentation comprehensive +- [ ] Examples working