Skip to content

Conversation

@rahul31124
Copy link
Contributor

@rahul31124 rahul31124 commented Dec 8, 2025

Fixes:

  • GitHub was not detecting the issue template because they were not placed inside the .github/ISSUE_TEMPLATE/ directory.

Changes

  • Moved all issue template files into the correct .github/ISSUE_TEMPLATE/ folder.

Screenshots / Recordings

N/A

Checklist:

  • No hard coding: I have used values from constants.dart or localization files instead of hard-coded values.
  • No end of file edits: No modifications done at end of resource files.
  • Code reformatting: I have formatted the code using dart format or the IDE formatter.
  • Code analysis: My code passes checks run in flutter analyze and tests run in flutter test.

Summary by Sourcery

Documentation:

  • Add structured templates for bug reports, feature requests, and general issues to guide contributors when opening issues.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 8, 2025

Reviewer's Guide

Moves GitHub issue templates into the correct .github/ISSUE_TEMPLATE/ directory and defines structured templates for bug reports, feature requests, and general issues so that GitHub recognizes them properly.

Flow diagram for GitHub detecting and using the issue templates

flowchart TD
  A[Repository] --> B[.github directory]
  B --> C[ISSUE_TEMPLATE directory]
  C --> D[report-a-bug.md]
  C --> E[feature_request.md]
  C --> F[general-issues.md]

  G[GitHub issue creation] --> H{Are templates in .github/ISSUE_TEMPLATE?}
  H -->|Yes| I[Read report-a-bug feature_request general-issues metadata]
  H -->|No| J[Show default blank issue form]

  I --> K[Render issue template picker<br/>Bug report<br/>Feature request<br/>General issues]
  K --> L[User selects a template]
  L --> M[GitHub loads corresponding structured form]
Loading

File-Level Changes

Change Details Files
Add properly structured GitHub issue templates for bugs, feature requests, and general issues under the conventional ISSUE_TEMPLATE directory.
  • Create report-a-bug.md with front matter metadata and guided sections for describing bugs, reproduction steps, logs, screenshots, system information, and contributor interest.
  • Create feature_request.md with front matter metadata and sections for current behavior, desired behavior, implementation ideas, extra context, and contributor interest.
  • Create general-issues.md with front matter metadata and prompts for describing miscellaneous issues and contributor interest.
  • Remove the old .github/ISSUE_TEMPLATE file so GitHub can pick up the new markdown-based templates.
.github/ISSUE_TEMPLATE/report-a-bug.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/general-issues.md
.github/ISSUE_TEMPLATE

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

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 there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `.github/ISSUE_TEMPLATE/report-a-bug.md:3` </location>
<code_context>
+---
+name: Report a bug
+about: 'Report a bug which you have noticed, to help us improve PSLab '
+title: ''
+labels: bug
</code_context>

<issue_to_address>
**suggestion (typo):** Tighten the wording and remove the extra space in the `about` text.

Please change this to `Report a bug that you have noticed to help us improve PSLab` (no comma) and remove the trailing space before the closing quote.

```suggestion
about: 'Report a bug that you have noticed to help us improve PSLab'
```
</issue_to_address>

### Comment 2
<location> `.github/ISSUE_TEMPLATE/report-a-bug.md:22-23` </location>
<code_context>
-
-<!-- Provide logs for the crash here -->
-
-**Screenshots of the issue**
-
-<!-- Where-ever possible add a screenshot of the issue. -->
</code_context>

<issue_to_address>
**issue (typo):** Fix the spelling of “Where-ever” to “Wherever”.

In the screenshots section comment, change `Where-ever` to `Wherever` (one word).

```suggestion
**Screenshots of the issue**
<!--Wherever possible add a screenshot of the issue. Use `<img src="paste-link-here" width=200 />` tag-->
```
</issue_to_address>

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.

@rahul31124 rahul31124 requested a review from marcnause December 8, 2025 10:19
@rahul31124
Copy link
Contributor Author

Hello @marcnause 😅, the issue template I previously added were not being detected because they were placed in the wrong folder structure. I discovered that GitHub only recognizes templates inside .github/ISSUE_TEMPLATE/. I have now corrected the folder structure so the templates load properly

Copy link
Contributor

@marcnause marcnause left a comment

Choose a reason for hiding this comment

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

I noticed that the templates were not working yesterday when I created a bunch of new issues. Great that you have a fix for it today! Thanks for continuing to take care of this.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@marcnause marcnause enabled auto-merge (squash) December 8, 2025 20:49
@marcnause marcnause merged commit 0640f8d into fossasia:flutter Dec 8, 2025
11 of 12 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2025

Build Status

Build successful. APKs to test: https://github.com/fossasia/pslab-app/actions/runs/20042359434/artifacts/4802935378.

Screenshots

Android Screenshots
iPhone Screenshots
iPad Screenshots

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