Skip to content

docs: add pull request template - #28

Open
hasansezertasan wants to merge 1 commit into
mainfrom
docs/pull-request-template
Open

docs: add pull request template#28
hasansezertasan wants to merge 1 commit into
mainfrom
docs/pull-request-template

Conversation

@hasansezertasan

@hasansezertasan hasansezertasan commented Jul 22, 2026

Copy link
Copy Markdown
Member

Description

Adds .github/PULL_REQUEST_TEMPLATE.md so new PRs are pre-populated with a consistent structure: Code of Conduct / contribution links, a Description section, and a Closes section for issue linking.

Content adopted verbatim from #16 (the copier-based PR), matching the maintainers' latest intent. Note this template is intentionally minimal — the older checklist (coverage/docs/pre-commit/tests) was dropped in #16, and this PR preserves that decision.

Closes

Summary by Sourcery

Documentation:

  • Introduce a minimal .github/PULL_REQUEST_TEMPLATE.md documenting required description and issue-closing sections for new pull requests.

Add .github/PULL_REQUEST_TEMPLATE.md with Code of Conduct and
contribution links, a Description section, and a Closes section
for issue linking. Adopted from #16.

Closes #25
@hasansezertasan hasansezertasan added the documentation Improvements or additions to documentation label Jul 22, 2026
@sourcery-ai

sourcery-ai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a minimal, standardized pull request template under .github that enforces code of conduct & contribution guideline links and provides structured Description and Closes sections for new PRs.

File-Level Changes

Change Details Files
Introduce a minimal, standardized pull request template for all new PRs.
  • Create .github/PULL_REQUEST_TEMPLATE.md to be auto-loaded when opening pull requests.
  • Include a Description section with a placeholder line for authors to summarize changes.
  • Include a Closes section for explicitly listing issues closed by the PR, with guidance and examples in comments.
  • Add introductory comment block reminding contributors of relevant Codes of Conduct and contribution guidelines, with links.
  • Embed GitHub documentation link explaining supported issue-linking keywords to ensure proper issue association.
.github/PULL_REQUEST_TEMPLATE.md

Assessment against linked issues

Issue Objective Addressed Explanation
#25 Add a .github/PULL_REQUEST_TEMPLATE.md file so new pull requests use a consistent template.
#25 Include in the pull request template: links to the Code of Conduct and contribution guidelines, a Description section, and a section for closing/linked issues.
#25 Add a checklist to the pull request template covering 100% test coverage, documentation updates, running pre-commit, and running tests. The PR explicitly states that the older checklist (coverage/docs/pre-commit/tests) was dropped in the upstream template and therefore is not included; the added template does not contain any checklist items.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • Consider replacing the literal '-' under the Description section with a brief HTML comment prompt (e.g., what details to include) so new PR authors aren’t tempted to leave the placeholder as-is.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider replacing the literal '-' under the Description section with a brief HTML comment prompt (e.g., what details to include) so new PR authors aren’t tempted to leave the placeholder as-is.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add Pull Request template

2 participants