Skip to content

feat: add pull request templates for bug fixes, features, and integrations#1044

Merged
Crunchyman-ralph merged 6 commits intonextfrom
chore/improve.pull_request_template
Jul 24, 2025
Merged

feat: add pull request templates for bug fixes, features, and integrations#1044
Crunchyman-ralph merged 6 commits intonextfrom
chore/improve.pull_request_template

Conversation

@Crunchyman-ralph
Copy link
Collaborator

@Crunchyman-ralph Crunchyman-ralph commented Jul 24, 2025

  • 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.

Summary by CodeRabbit

  • Documentation

    • Introduced new pull request templates to standardize submissions for bug fixes, new features, and integrations.
    • Added detailed contributor and maintainer checklists to guide the review process.
    • Implemented a configuration to streamline template selection and disable blank issues.
  • Style

    • Simplified the formatting of the "workspaces" field in the project configuration for improved readability.

…tions

- 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.
@changeset-bot
Copy link

changeset-bot bot commented Jul 24, 2025

⚠️ No Changeset found

Latest commit: 8e51cc6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 24, 2025

Warning

Rate limit exceeded

@Crunchyman-ralph has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 46 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8631527 and 8e51cc6.

📒 Files selected for processing (2)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
  • .github/PULL_REQUEST_TEMPLATE/integration.md (1 hunks)

Walkthrough

Several new pull request template markdown files and a configuration file were added under the .github/PULL_REQUEST_TEMPLATE directory to standardize and guide contributors through different PR types (bugfix, feature, integration, general). The package.json was also updated to reformat the "workspaces" field into a single line.

Changes

File(s) Change Summary
.github/PULL_REQUEST_TEMPLATE.md Added a general pull request template with structured sections for PR type, description, issues, testing, and checklists.
.github/PULL_REQUEST_TEMPLATE/bugfix.md Added a bugfix-specific pull request template with sections for bug description, testing, and checklists.
.github/PULL_REQUEST_TEMPLATE/feature.md Added a feature-specific pull request template with sections for feature description, usage, and checklists.
.github/PULL_REQUEST_TEMPLATE/integration.md Added an integration-specific pull request template with sections for integration details, testing, and checklists.
.github/PULL_REQUEST_TEMPLATE/config.yml Added configuration to disable blank issues and define contact links for different PR types.
package.json Reformatted the "workspaces" array from multi-line to single-line; no functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/improve.pull_request_template

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🔭 Outside diff range comments (2)
.github/PULL_REQUEST_TEMPLATE/bugfix.md (1)

1-40: Apply markdown-lint spacing to avoid CI noise

As with the integration template, consecutive headings / lists violate MD022/MD032 and MD041 (missing H1). Add blank lines after each heading and before/after fenced blocks.

-## 🐛 Bug Fix
+# 🐛 Bug Fix
+
 ### 🔍 Bug Description
+
 <!-- Describe the bug -->
+
 ### 🔗 Related Issues
+
 <!-- Fixes #123 -->
+
 ### ✨ Solution
+
 <!-- How does this PR fix the bug? -->
+
 ## How to Test
+
 ### Steps that caused the bug:
+
 1.
 2.

Updating the rest of the file accordingly will keep markdown-lint green.

.github/PULL_REQUEST_TEMPLATE/feature.md (1)

1-50: Consistent heading hierarchy & blank-line spacing needed

Same lint breaks here: first line should be H1, headings require surrounding blank lines, fenced code blocks need padding.

-## ✨ New Feature
+# ✨ New Feature
+
 ### 📋 Feature Description
+
 <!-- Brief description -->
+
 ### 🎯 Problem Statement
+
 <!-- What problem does this feature solve? Why is it needed? -->
+
 ### 💡 Solution
+
 <!-- How does this feature solve the problem? What's the approach? -->
+
 ### 🔗 Related Issues
+
 <!-- Link related issues: Fixes #123, Part of #456 -->
+
 ## How to Use It
+
 ### Quick Start
+
 ```bash
 # Basic usage example

Propagate the pattern through the remainder of the template.

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: ASSERTIVE**
**Plan: Pro**


<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 31b8407dbc16a6c1f61a2910314ca1b5c31b1163 and 86315279a80e65b1b0fe703534efadb973ab257a.

</details>

<details>
<summary>📒 Files selected for processing (6)</summary>

* `.github/PULL_REQUEST_TEMPLATE.md` (1 hunks)
* `.github/PULL_REQUEST_TEMPLATE/bugfix.md` (1 hunks)
* `.github/PULL_REQUEST_TEMPLATE/config.yml` (1 hunks)
* `.github/PULL_REQUEST_TEMPLATE/feature.md` (1 hunks)
* `.github/PULL_REQUEST_TEMPLATE/integration.md` (1 hunks)
* `package.json` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🧠 Learnings (2)</summary>

<details>
<summary>📓 Common learnings</summary>

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/git_workflow.mdc:0-0
Timestamp: 2025-07-18T17:10:31.773Z
Learning: Pull Request descriptions must use the provided template, including Task Overview, Subtasks Completed, Implementation Details, Testing, Breaking Changes, and Related Tasks


Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/changeset.mdc:0-0
Timestamp: 2025-07-18T17:07:53.100Z
Learning: Every pull request containing new features, bug fixes, breaking changes, performance improvements, significant refactoring, user-facing documentation updates, dependency updates, or impactful build/tooling changes should include a changeset file.


Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/git_workflow.mdc:0-0
Timestamp: 2025-07-18T17:10:31.773Z
Learning: Pull Request titles must follow the format: Task :


Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.647Z
Learning: Guidelines for integrating new features into the Task Master CLI with tagged system considerations (new_features.mdc).


Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/git_workflow.mdc:0-0
Timestamp: 2025-07-18T17:10:31.773Z
Learning: Use commit type prefixes: feat(task-X):, fix(task-X):, test(task-X):, docs(task-X):, refactor(task-X):, chore(task-X): for all commits


</details>
<details>
<summary>.github/PULL_REQUEST_TEMPLATE/integration.md (10)</summary>

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.647Z
Learning: Guidelines for integrating new features into the Task Master CLI with tagged system considerations (new_features.mdc).

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.647Z
Learning: Guide for using Task Master to manage task-driven development workflows with tagged task lists support (dev_workflow.mdc).

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.647Z
Learning: Guidelines for implementing and maintaining tests for Task Master CLI (tests.mdc).

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: assets/.windsurfrules:0-0
Timestamp: 2025-07-18T17:19:27.346Z
Learning: Use `task-master add-task` to add a new task to tasks.json using AI.

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/new_features.mdc:0-0
Timestamp: 2025-07-18T17:12:57.858Z
Learning: Applies to scripts/modules/**/*.test.js : Test CLI and MCP interfaces with real task data, verify end-to-end workflows across tag contexts, and test error scenarios and recovery in integration tests.

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: assets/.windsurfrules:0-0
Timestamp: 2025-07-18T17:19:27.346Z
Learning: View specific task details using `task-master show <id>` to understand implementation requirements.

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.647Z
Learning: Describes the high-level architecture of the Task Master CLI application, including the new tagged task lists system (architecture.mdc).

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.647Z
Learning: Guidelines for integrating AI usage telemetry across Task Master (telemetry.mdc).

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/tasks.mdc:0-0
Timestamp: 2025-07-18T17:14:29.373Z
Learning: Applies to scripts/modules/task-manager.js : Use consistent formatting for task files, include all task properties in text files, and format dependencies with status indicators.

Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/dev_workflow.mdc:0-0
Timestamp: 2025-07-18T17:10:12.852Z
Learning: Use the Taskmaster command set (`task-master` CLI or MCP tools) for all task management operations: listing, expanding, updating, tagging, and status changes.

</details>

</details><details>
<summary>🪛 YAMLlint (1.37.1)</summary>

<details>
<summary>.github/PULL_REQUEST_TEMPLATE/config.yml</summary>

[error] 11-11: no new line character at the end of file

(new-line-at-end-of-file)

</details>

</details>
<details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>.github/PULL_REQUEST_TEMPLATE/integration.md</summary>

[grammar] ~1-~1: Use correct spacing
Context: ## 🔌 New Integration  ### What tool/IDE is being integrated? <!-- ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~3-~3: Use correct spacing
Context: ...Integration  ### What tool/IDE is being integrated? <!-- Name and brief description -->  ### What can users do with it? <!-- Key bene...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~6-~6: Use correct spacing
Context: ...ription -->  ### What can users do with it? <!-- Key benefits -->  ## How to Enable  ### Setup ```bash task-ma...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~9-~9: Use correct spacing
Context: ...th it? <!-- Key benefits -->  ## How to Enable  ### Setup ```bash task-master rules add [nam...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~17-~17: Use correct spacing
Context: ... Any other setup steps ```  ### Example Usage <!-- Show it in action --> ```bash # Real example ```  ### Natural Language Hooks (if applicable) `...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~23-~23: Use correct spacing
Context: ...ple ```  ### Natural Language Hooks (if applicable) ``` "When tests pass, mark task as done" # Other examples ```  ## Contributor Checklist - [ ] Created chan...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~38-~38: Use correct spacing
Context: ...up guide - [ ] Examples are working and clear  ---  ### For Maintainers  - [ ] Integration stabi...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~42-~42: Use correct spacing
Context: ...les are working and clear  ---  ### For Maintainers  - [ ] Integration stability verified - [ ]...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

</details>
<details>
<summary>.github/PULL_REQUEST_TEMPLATE/feature.md</summary>

[grammar] ~1-~1: Use correct spacing
Context: ## ✨ New Feature  ### 📋 Feature Description <!-- Brief descri...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~3-~3: Use correct spacing
Context: ## ✨ New Feature  ### 📋 Feature Description <!-- Brief description -->  ### 🎯 Problem Statement <!-- What problem d...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~6-~6: Use correct spacing
Context: ...- Brief description -->  ### 🎯 Problem Statement <!-- What problem does this feature solve? Why is it needed? -->  ### 💡 Solution <!-- How does this feature s...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~9-~9: Use correct spacing
Context: ...re solve? Why is it needed? -->  ### 💡 Solution <!-- How does this feature solve the problem? What's the approach? -->  ### 🔗 Related Issues <!-- Link related issu...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~12-~12: Use correct spacing
Context: ...hat's the approach? -->  ### 🔗 Related Issues <!-- Link related issues: Fixes #123, Part of #456 -->  ## How to Use It  ### Quick Start ```bash #...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~15-~15: Use correct spacing
Context: ...s #123, Part of #456 -->  ## How to Use It  ### Quick Start ```bash # Basic usage exampl...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~17-~17: Use correct spacing
Context: ...f #456 -->  ## How to Use It  ### Quick Start ```bash # Basic usage example ```  ### Example <!-- Show a real use case --> ``...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~28-~28: Use correct spacing
Context: ...ractical example ```  **What you should see:** <!-- Expected behavior -->  ## Contributor Checklist - [ ] Created chan...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~38-~38: Use correct spacing
Context: ...e - [ ] Manually tested in MCP mode (if applicable)  ## Changelog Entry <!-- One-liner for relea...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~40-~40: Use correct spacing
Context: ... MCP mode (if applicable)  ## Changelog Entry <!-- One-liner for release notes -->  ---  ### For Maintainers  - [ ] Feature aligns wi...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~45-~45: Use correct spacing
Context: ...ner for release notes -->  ---  ### For Maintainers  - [ ] Feature aligns with project vision -...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

</details>
<details>
<summary>.github/PULL_REQUEST_TEMPLATE/bugfix.md</summary>

[grammar] ~1-~1: Use correct spacing
Context: ## 🐛 Bug Fix  ### 🔍 Bug Description <!-- Describe the bug...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~3-~3: Use correct spacing
Context: ## 🐛 Bug Fix  ### 🔍 Bug Description <!-- Describe the bug -->  ### 🔗 Related Issues <!-- Fixes #123 -->  #...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~6-~6: Use correct spacing
Context: ...-- Describe the bug -->  ### 🔗 Related Issues <!-- Fixes #123 -->  ### ✨ Solution <!-- How does this PR fix the...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~9-~9: Use correct spacing
Context: ...lated Issues <!-- Fixes #123 -->  ### ✨ Solution <!-- How does this PR fix the bug? -->  ## How to Test  ### Steps that caused the b...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~12-~12: Use correct spacing
Context: ...oes this PR fix the bug? -->  ## How to Test  ### Steps that caused the bug: 1.  2.   **Be...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~14-~14: Use correct spacing
Context: ... How to Test  ### Steps that caused the bug: 1.  2.   **Before fix:**  **After fix:**   ### Quic...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~19-~19: Use correct spacing
Context: ... bug: 1.  2.   **Before fix:**  **After fix:**   ### Quick verification: ```bash # Commands t...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~21-~21: Use correct spacing
Context: ...fore fix:**  **After fix:**   ### Quick verification: ```bash # Commands to verify the fix ```  ## Contributor Checklist - [ ] Created chan...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~32-~32: Use correct spacing
Context: ...icable) - [ ] Manually verified the fix works  ---  ### For Maintainers - [ ] Root cause identif...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

</details>

</details>
<details>
<summary>🪛 markdownlint-cli2 (0.17.2)</summary>

<details>
<summary>.github/PULL_REQUEST_TEMPLATE/integration.md</summary>

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

---

14-14: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

14-14: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

---

15-15: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

15-15: Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

16-16: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

18-18: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

19-19: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

21-21: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

---

22-22: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

26-26: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

27-27: Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

36-36: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

37-37: Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

39-39: Files should end with a single newline character

(MD047, single-trailing-newline)

</details>
<details>
<summary>.github/PULL_REQUEST_TEMPLATE/feature.md</summary>

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

---

17-17: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

18-18: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

31-31: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

32-32: Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

</details>
<details>
<summary>.github/PULL_REQUEST_TEMPLATE.md</summary>

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

---

8-8: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

25-25: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

26-26: Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

39-39: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

40-40: Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

43-43: Files should end with a single newline character

(MD047, single-trailing-newline)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>package.json (1)</summary>

`12-12`: **Formatting change is harmless – approved**

The line-array → single-line change does not impact behaviour and keeps JSON valid.  
No further action required.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Comment on lines +10 to +24
## Description
<!-- What does this PR do? -->

## Related Issues
<!-- Link issues: Fixes #123 -->

## How to Test This
<!-- Quick steps to verify the changes work -->
```bash
# Example commands or steps
```

**Expected result:**
<!-- What should happen? -->

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add sections required by internal contribution guidelines

Our documented workflow (see .cursor/rules/git_workflow.mdc) expects PRs to contain:

• Task Overview / Implementation Details
• Sub-tasks completed
• Breaking Changes & Related Tasks

Consider expanding the template here to keep every PR uniformly descriptive and reduce back-and-forth with reviewers.

Example insertion after “Description”:

## Implementation Details
<!-- Technical notes, libraries touched, rationale -->

## Breaking Changes
<!-- API removals, behavioural shifts, migration notes -->

## Sub-tasks Completed
<!-- Bullet list of finished work items -->
🤖 Prompt for AI Agents
In .github/PULL_REQUEST_TEMPLATE.md around lines 10 to 24, the PR template lacks
sections required by internal contribution guidelines. Add new sections after
"Description" titled "Implementation Details," "Breaking Changes," and
"Sub-tasks Completed" with appropriate placeholders for technical notes, API
changes, and completed work items to ensure uniform and comprehensive PR
descriptions.

Comment on lines +1 to +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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Terminate file with a newline

YAML-lint flags the missing trailing newline (MD047 / new-line-at-end-of-file).
Add a single “\n” after line 11.

   about: Add support for a new tool, IDE, or platform
+        ## EOF newline

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 11-11: no new line character at the end of file

(new-line-at-end-of-file)

🤖 Prompt for AI Agents
In .github/PULL_REQUEST_TEMPLATE/config.yml at the end of line 11, add a single
newline character to ensure the file ends with a newline. This will fix the
YAML-lint warning about the missing trailing newline.

Crunchyman-ralph and others added 4 commits July 24, 2025 15:51
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@Crunchyman-ralph
Copy link
Collaborator Author

@CodeRabbit review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 24, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

2 similar comments
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 24, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 24, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@Crunchyman-ralph
Copy link
Collaborator Author

@CodeRabbit review one last time

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 24, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@Crunchyman-ralph, I'll conduct a thorough review of your pull request templates. Let me analyze the structure and content of each template.


🏁 Script executed:

#!/bin/bash
# Review the structure of all PR template files
echo "=== General Template ==="
cat .github/PULL_REQUEST_TEMPLATE.md

echo -e "\n=== Config File ==="
cat .github/PULL_REQUEST_TEMPLATE/config.yml

echo -e "\n=== Bug Fix Template ==="
cat .github/PULL_REQUEST_TEMPLATE/bugfix.md

echo -e "\n=== Feature Template ==="
cat .github/PULL_REQUEST_TEMPLATE/feature.md

echo -e "\n=== Integration Template ==="
cat .github/PULL_REQUEST_TEMPLATE/integration.md

echo -e "\n=== Package.json changes ==="
git diff HEAD~1 package.json

Length of output: 5026


Excellent work on these PR templates! I've reviewed all the templates and they're very comprehensive. Here's my analysis:

Strengths

Structure & Consistency:

  • All templates follow a logical flow: description → testing/usage → checklists
  • Consistent use of emojis and formatting across templates
  • Clear separation between contributor and maintainer responsibilities
  • Good use of code blocks and examples throughout

Comprehensive Coverage:

  • General template covers all PR types with appropriate checkboxes
  • Specialized templates provide targeted guidance for specific scenarios
  • Integration template includes natural language hooks section (great for your project!)
  • All include changeset reminders (addressing the bot's concern)

Practical Elements:

  • "How to Test" sections with concrete examples
  • Quick verification commands
  • Expected results clearly stated
  • Changelog entry prompts for better release notes

🔧 Minor Suggestions

  1. Config URLs: The template URLs in config.yml use template=bugfix.md format. Verify these work as expected with GitHub's template system.

  2. Consistency: The general template uses "Format check passes" while others use "Format check passes:" - consider standardizing the colon usage.

  3. Integration Template: Consider adding a "Prerequisites" section for any dependencies or setup requirements.

  4. Error Handling: The integration template mentions "Error scenarios tested" - excellent inclusion!

🎯 Overall Assessment

This is a well-thought-out template system that will significantly improve PR quality and consistency. The templates strike a good balance between being comprehensive and not overwhelming contributors.

Recommendation:Approve - These templates are ready for production use and will greatly benefit your project's contribution process.

The changeset-bot reminder is actually helpful here - you'll want to add one since this is a feature addition that improves the developer experience.

🐰 These templates look great! I'm excited to see how they'll streamline your contribution process.

@Crunchyman-ralph Crunchyman-ralph merged commit 1bd1e64 into next Jul 24, 2025
4 checks passed
Crunchyman-ralph added a commit to DavidMaliglowka/claude-task-master that referenced this pull request Jul 28, 2025
…tions (eyaltoledano#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>
stephanschielke pushed a commit to stephanschielke/cursor-task-master that referenced this pull request Aug 22, 2025
…tions (eyaltoledano#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>
stephanschielke pushed a commit to stephanschielke/cursor-task-master that referenced this pull request Aug 22, 2025
…tions (eyaltoledano#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>
sfc-gh-dflippo pushed a commit to sfc-gh-dflippo/task-master-ai that referenced this pull request Dec 4, 2025
…tions (eyaltoledano#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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant