Skip to content

chore: add pull request template#267

Open
peteski22 wants to merge 1 commit into
mainfrom
chore/add-pr-template
Open

chore: add pull request template#267
peteski22 wants to merge 1 commit into
mainfrom
chore/add-pr-template

Conversation

@peteski22

@peteski22 peteski22 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Adds a PR template based on the any-llm project template, with the contribution guidelines link pointing to this repo.

Summary by CodeRabbit

  • Chores
    • Enhanced pull request template with structured sections for contributor information, issue tracking, and submission guidelines to streamline the review process.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

A new GitHub pull request template is added at .github/pull_request_template.md. It defines sections for PR description, PR type checkboxes, relevant issues, a contributor checklist, and an AI usage information section with model/tool fields and an AI-agent indicator checkbox.

Changes

Pull Request Template

Layer / File(s) Summary
PR template structure and fields
.github/pull_request_template.md
Introduces the full pull request template with a description area, PR type checkboxes (new feature, bug fix, refactor, docs, infrastructure), relevant-issues prompt, contributor checklist covering tests, local verification, doc updates, and contribution guideline acknowledgement, plus an AI usage section with model/tool fields and an AI-agent checkbox.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: add pull request template' accurately describes the primary change: adding a PR template to the repository. It is concise, clear, and directly related to the main changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/add-pr-template

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/pull_request_template.md:
- Line 1: The pull request template file begins with a level-2 heading (`##
Description`) but GitHub PR templates should conventionally start with a level-1
heading. Change the first line from `## Description` to `# Description` to use
the correct heading hierarchy for the template structure.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 26db78bc-750f-4a81-804b-5f6c59e04d4a

📥 Commits

Reviewing files that changed from the base of the PR and between b85ec19 and d8bcb27.

📒 Files selected for processing (1)
  • .github/pull_request_template.md

@@ -0,0 +1,39 @@
## Description

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

File should start with a top-level heading (#) rather than level-2 heading (##).

GitHub PR templates conventionally begin with a level-1 heading. Update line 1 to use # PR Title or similar, or restructure the template hierarchy accordingly.

📝 Proposed fix
-## Description
-<!-- What does this PR do? -->
+# Pull Request
+
+## Description
+<!-- What does this PR do? -->
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

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

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

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/pull_request_template.md at line 1, The pull request template file
begins with a level-2 heading (`## Description`) but GitHub PR templates should
conventionally start with a level-1 heading. Change the first line from `##
Description` to `# Description` to use the correct heading hierarchy for the
template structure.

Source: Linters/SAST tools

@peteski22 peteski22 requested a review from dpoulopoulos June 23, 2026 10:58
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.

2 participants