Skip to content
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.

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

chore: update pull request template #58

Merged
merged 11 commits into from
Mar 10, 2025
Merged

chore: update pull request template #58

merged 11 commits into from
Mar 10, 2025

Conversation

JaeAeich
Copy link
Collaborator

@JaeAeich JaeAeich commented Jan 9, 2025

Description

Updates the pr template for cookicutter repo and also relax/shorten for the proj generated by it. Also fixes formatting issue with mdformat.

Comments

Summary by Sourcery

Simplify the pull request template by reducing the number of checklist items and grouping related items together.

Documentation:

  • Improve the contributor guidelines by clarifying the PR review process.

Chores:

  • Update the pull request template to streamline the review process.

Copy link

sourcery-ai bot commented Jan 9, 2025

Reviewer's Guide by Sourcery

This PR updates the pull request template to streamline the checklist and improve clarity. It condenses several checklist items, combines related checks, and removes the explicit Conventional Commits specification from the checklist, as it is already mentioned in the contributing guidelines.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the PR template checklist by simplifying and combining several items into more concise statements.
  • Combined multiple checklist items related to code style, documentation, and testing into single, more comprehensive checks.
  • Removed the separate checklist item for Conventional Commits, as it's already part of the contributing guidelines.
  • Simplified the language in several checklist items to improve clarity and conciseness.
  • Combined the self-review and documentation update checklist items.
  • Combined type annotation and documentation checklist items.
  • Combined the code coverage and testing checklist items.
PULL_REQUEST_TEMPLATE.md
Removed the explicit link to the Conventional Commits specification.
  • Removed the link to the Conventional Commits specification from the checklist section.
  • Removed the explanation regarding squashing commits and commit messages from the checklist section.
PULL_REQUEST_TEMPLATE.md

Assessment against linked issues

Issue Objective Addressed Explanation
#51 Reduce the number of unnecessary checklist items in the pull request template
#51 Simplify the checklist to focus on key aspects like test coverage
#51 Prevent misleading task completion indicators in GitHub

Possibly linked issues


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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JaeAeich - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider keeping the explicit conventional commits checkbox to ensure consistent commit message formatting, while maintaining the improved template conciseness.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@JaeAeich JaeAeich requested a review from uniqueg January 9, 2025 12:38
@JaeAeich JaeAeich requested a review from uniqueg January 9, 2025 16:46
@JaeAeich JaeAeich requested a review from uniqueg January 14, 2025 16:50
@JaeAeich
Copy link
Collaborator Author

Change to unordered list, looks wierd.

image

@JaeAeich JaeAeich merged commit a9d4a00 into main Mar 10, 2025
@JaeAeich JaeAeich deleted the prtemp branch March 10, 2025 04:57
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.

imp: relaxing pull request template
2 participants