Skip to content

[Feature] Updated Issue and PR templates #99

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

Merged
merged 1 commit into from
Jun 1, 2025

Conversation

vedansh-5
Copy link
Contributor

@vedansh-5 vedansh-5 commented May 31, 2025

Closes #98

Summary by Sourcery

Revamp GitHub Issue and Pull Request templates to include standardized metadata, structured sections, and checklists for bug reports and contributions.

Documentation:

  • Add frontmatter and reorganize ISSUE_TEMPLATE with titled sections for actual/expected behavior, screenshots, reproduction steps, possible solutions, and contribution intent
  • Enhance PULL_REQUEST_TEMPLATE with standardized fix footer, change summary section, screenshots/demo area, contribution checklist, and reviewer notes

Signed-off-by: Vedansh Saini <[email protected]>
Copy link
Contributor

sourcery-ai bot commented May 31, 2025

Reviewer's Guide

This PR overhauls the GitHub issue and pull request templates to a more structured format, adding frontmatter, standardized headings, emojis, checklists, and automation directives for clearer contributor guidance and streamlined issue/PR workflows.

File-Level Changes

Change Details Files
Revamped ISSUE_TEMPLATE.md to a structured, frontmatter-driven bug/feature template
  • Added YAML frontmatter (name, about, title, labels, assignees)
  • Introduced emoji-based section headings (Actual Behaviour, Expected Behaviour, Screenshots, Steps to Reproduce, Possible Solution, Would You Like to Work on It)
  • Formatted reproducibility steps and contributor assignment prompt
.github/ISSUE_TEMPLATE.md
Overhauled PULL_REQUEST_TEMPLATE.md with detailed sections, checklist, and automations
  • Standardized fix directive to “Fixes #”
  • Added sections for Summary of Changes, Screenshots/Demo, and Reviewer Notes
  • Included a testing/documentation checklist and markdown separators
.github/PULL_REQUEST_TEMPLATE.md

Assessment against linked issues

Issue Objective Addressed Explanation

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. 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

@vedansh-5 vedansh-5 self-assigned this May 31, 2025
@vedansh-5 vedansh-5 requested review from mariobehling and hpdang May 31, 2025 11:51
Copy link
Contributor

@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 @vedansh-5 - I've reviewed your changes - here's some feedback:

  • Consider splitting the unified "Bug Report / Feature Request" template into two separate templates to make triaging and labeling more straightforward.
  • The blank assignees: field can be removed or clarified to avoid confusion about assignment expectations.
  • Standardize heading levels and emoji usage across both templates to align with existing project style and improve readability.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: 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.

@hpdang hpdang merged commit f09ebdc into fossasia:master Jun 1, 2025
@vedansh-5 vedansh-5 deleted the githubTemplates branch June 4, 2025 08:08
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.

Enhance Issue and PR templates
2 participants