Skip to content

add pull request template #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
f-leu merged 2 commits into from
Jan 8, 2026
Merged

add pull request template #231

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d8be6f
add pull request template
f-leu Jan 8, 2026
c252758
update pull request template
f-leu Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!--
Please provide a short, descriptive title for your pull request.

🚨 Please do not remove any of the sections below.
-->

# [Title]

## 📚 Description of Changes

_Provide an overview of your changes and why they’re needed. Link to any related issues (e.g., "Fixes #123"). If your PR fixes a bug, resolves a feature request, or updates documentation, please explain how._

- **What Changed:**
(Describe the modifications, additions, or removals.)

- **Why This Change:**
(Explain the problem this PR addresses or the improvement it provides.)

- **Affected Components:**
(Which component does this change affect? - put x for all components)
- [ ] Compose
- [ ] K8s
- [ ] Other (please specify)

## ❓ Motivation and Context

_Why is this change required? What problem does it solve?_

- **Context:**
(Provide background information or link to related discussions/issues.)

- **Relevant Tasks/Issues:**
(e.g., Fixes: #GitHub Issue)

## 🔍 Types of Changes

_Indicate which type of changes your code introduces (check all that apply):_

- [ ] **BUGFIX:** Non-breaking fix for an issue.
- [ ] **NEW FEATURE:** Non-breaking addition of functionality.
- [ ] **BREAKING CHANGE:** Fix or feature that causes existing functionality to not work as expected.
- [ ] **ENHANCEMENT:** Improvement to existing functionality.
- [ ] **CHORE:** Changes that do not affect production (e.g., documentation, build tooling, CI).

## 🔬 QA / Verification Steps

_Describe the steps a reviewer should take to verify your changes:_

1. (Step one: e.g., "Run `make test` to verify all tests pass.")
2. (Step two: e.g., "Deploy to a Kind cluster with `make create-kind && make deploy`.")
3. (Additional steps as needed.)

## ✅ Global Checklist

_Please check all boxes that apply:_

- [ ] I have read and followed the [CONTRIBUTING guidelines](.github/CONTRIBUTING.md).
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Jan 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Correct capitalization: "CONTRIBUTING guidelines" link reference.

Update the link reference to use the correct capitalization for consistency with GitHub's naming conventions.

✏️ Proposed fix 
-- [ ] I have read and followed the [CONTRIBUTING guidelines](.github/CONTRIBUTING.md).
+- [ ] I have read and followed the [Contributing guidelines](.github/CONTRIBUTING.md).
🧰 Tools
🪛 LanguageTool

[uncategorized] ~57-~57: The official name of this software platform is spelled with a capital “H”.
Context: ...nd followed the CONTRIBUTING guidelines. - [ ] My code follows...

(GITHUB)

🤖 Prompt for AI Agents 
In @.github/PULL_REQUEST_TEMPLATE.md at line 57, Update the link text
“[CONTRIBUTING guidelines]” to use the correct capitalization by changing it to
“[CONTRIBUTING Guidelines]” so the link label matches the repository naming
convention while keeping the target (.github/CONTRIBUTING.md) unchanged.

- [ ] My code follows the code style of this project.
- [ ] I have updated the documentation as needed.
- [ ] I have added tests that cover my changes.
- [ ] All new and existing tests have passed locally.
- [ ] I have run this code in a local environment to verify functionality.
- [ ] I have considered the security implications of this change.
Loading