Skip to content

chore: update issue & PR templates#6673

Merged
dogancanbakir merged 2 commits intodevfrom
dwisiswant0/chore/update-issue-and-pr-templates
Dec 19, 2025
Merged

chore: update issue & PR templates#6673
dogancanbakir merged 2 commits intodevfrom
dwisiswant0/chore/update-issue-and-pr-templates

Conversation

@dwisiswant0
Copy link
Copy Markdown
Member

@dwisiswant0 dwisiswant0 commented Dec 7, 2025

Proposed changes

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Summary by CodeRabbit

  • Chores
    • Updated the pull request template to include a new "Proof" section for documenting testing and validation of changes.

✏️ Tip: You can customize this high-level summary in your review settings.

Signed-off-by: Dwi Siswanto <git@dw1.io>
@dwisiswant0 dwisiswant0 requested a review from ehsandeep December 7, 2025 18:36
@auto-assign auto-assign Bot requested a review from dogancanbakir December 7, 2025 18:36
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 7, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • .github/ISSUE_TEMPLATE/bug-report.yml is excluded by !**/*.yml

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new "### Proof" section was added to the pull request template, providing a placeholder prompt for contributors to document how their changes were tested.

Changes

Cohort / File(s) Change Summary
Pull Request Template
.github/PULL_REQUEST_TEMPLATE.md
Added new "Proof" section with placeholder text for describing testing methodology and validation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes


Poem

🐰 A template refined, with proof in place,
Where testers can show their testing grace,
One section added, simple and neat,
Makes PRs more thorough, quite complete!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: update issue & PR templates' is directly related to the changeset, which modifies the pull request template by adding a new 'Proof' section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

Copy link
Copy Markdown
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: 0

🧹 Nitpick comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)

5-7: Consider a more conventional section name.

The new "### Proof" section is a helpful addition that encourages contributors to document their testing approach. However, the section name is somewhat informal. Consider more conventional alternatives like "### Testing" or "### How to Test" for better clarity and consistency with industry-standard PR template conventions.

Apply this diff if you'd like to use a more standard naming:

-### Proof
+### Testing

The guidance prompt itself is clear and actionable—this is a minor naming preference that can be deferred if your team prefers "Proof" as the convention.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe090d7 and ee597a8.

⛔ Files ignored due to path filters (1)
  • .github/ISSUE_TEMPLATE/bug-report.yml is excluded by !**/*.yml
📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)

Signed-off-by: Dwi Siswanto <git@dw1.io>
@dogancanbakir dogancanbakir merged commit 664a01e into dev Dec 19, 2025
3 checks passed
@dogancanbakir dogancanbakir deleted the dwisiswant0/chore/update-issue-and-pr-templates branch December 19, 2025 14:41
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