Skip to content

docs: Updating PR templates for the repo#641

Merged
dines-rl merged 4 commits intomainfrom
dines/add-pr-template
Nov 4, 2025
Merged

docs: Updating PR templates for the repo#641
dines-rl merged 4 commits intomainfrom
dines/add-pr-template

Conversation

@dines-rl
Copy link
Copy Markdown
Contributor

@dines-rl dines-rl commented Nov 4, 2025

User description

Adding PR templates to highlight the need to tag changes within the Client release process.


CodeAnt-AI Description

Add PR templates enforcing Conventional Commits and checklists

What Changed

  • Added three repository PR templates (bug fix, feature, and default) that require PR titles to follow the Conventional Commits format and provide examples.
  • Each template offers structured sections for Description, Motivation/Root Cause, Changes, Testing, and (for features) Breaking Changes to make intent and impact explicit.
  • Included checklists that prompt contributors to add/verify unit and integration tests, smoke tests, local verification, documentation updates, and to document breaking changes or regression tests.
  • Contributors now see clear prompts for expected information when opening a PR, helping reviewers find test status and migration notes quickly.

Impact

✅ Clearer PR titles following Conventional Commits
✅ Fewer PRs missing tests or verification
✅ Faster reviewer understanding of change intent

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

@codeant-ai
Copy link
Copy Markdown
Contributor

codeant-ai bot commented Nov 4, 2025

CodeAnt AI is reviewing your PR.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@dines-rl dines-rl enabled auto-merge (squash) November 4, 2025 22:26
@dines-rl dines-rl requested a review from tode-rl November 4, 2025 22:26
@codeant-ai codeant-ai bot added the size:L This PR changes 100-499 lines, ignoring generated files label Nov 4, 2025
@codeant-ai
Copy link
Copy Markdown
Contributor

codeant-ai bot commented Nov 4, 2025

CodeAnt AI finished reviewing your PR.

@dines-rl dines-rl merged commit 2deb187 into main Nov 4, 2025
7 checks passed
@dines-rl dines-rl deleted the dines/add-pr-template branch November 4, 2025 22:27
@stainless-app stainless-app bot mentioned this pull request Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants