Skip to content

Create Feature Issue Template#1880

Merged
infispiel merged 2 commits intomasterfrom
ci/feature-issue-template
Feb 25, 2026
Merged

Create Feature Issue Template#1880
infispiel merged 2 commits intomasterfrom
ci/feature-issue-template

Conversation

@infispiel
Copy link
Collaborator

@infispiel infispiel commented Feb 25, 2026

Create a new template for Issues that represents a new Feature.

Automatically adds the feature tag to the issue, and adds it to the DataFed project under the todo column.

Summary by Sourcery

New Features:

  • Introduce a dedicated GitHub issue template for feature requests, including sections for description, functional requirements, and tracking changes.

Create a new template for Issues that represents a new Feature.

Automatically adds the `feature` tag to the issue, and adds it to the DataFed project under the `todo` column.
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 25, 2026

Reviewer's Guide

Adds a new GitHub issue template for feature requests that standardizes feature descriptions and automatically categorizes them for the DataFed project.

Flow diagram for feature issue template application in GitHub

flowchart TD
  A[Contributor opens New Issue in DataFed repo] --> B{Selects template?}
  B -->|Feature Template| C[Load feature-template.md structure]
  B -->|Other template or blank| H[Use other issue flow]

  C --> D[User fills Feature Description]
  D --> E[User specifies Functional Requirements with checkboxes]
  E --> F[User notes Changes section]
  F --> G[Submit issue]

  G --> I[GitHub creates issue of type feature]
  I --> J[Assign to project DataFed]
  J --> K[Place in todo column]
Loading

File-Level Changes

Change Details Files
Introduce a standardized GitHub issue template for new feature requests.
  • Create a new issue template markdown file with frontmatter metadata describing the template name, description, and default issue title format
  • Add custom frontmatter fields to classify the issue as a feature and associate it with the DataFed project
  • Define sections for feature description, functional requirements with checkboxes, and a changelog area for ongoing updates
.github/ISSUE_TEMPLATE/feature-template.md

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 - I've found 2 issues, and left some high level feedback:

  • The issue template frontmatter is split into multiple --- blocks; GitHub expects a single YAML frontmatter block at the top, so consider merging all metadata (name, about, title, labels, assignees, type, projects) into one block.
  • To actually auto-apply the feature label as described, set labels: ['feature'] (or equivalent) in the frontmatter instead of leaving it as an empty string.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The issue template frontmatter is split into multiple `---` blocks; GitHub expects a single YAML frontmatter block at the top, so consider merging all metadata (name, about, title, labels, assignees, type, projects) into one block.
- To actually auto-apply the `feature` label as described, set `labels: ['feature']` (or equivalent) in the frontmatter instead of leaving it as an empty string.

## Individual Comments

### Comment 1
<location path=".github/ISSUE_TEMPLATE/feature-template.md" line_range="3" />
<code_context>
+---
+name: Feature Template
+about: Template for new features to DataFed
+title: "[Feature] Feature Title"
+labels: ''
</code_context>
<issue_to_address>
**suggestion (typo):** Consider rephrasing the 'about' line for more natural grammar.

"Template for new features to DataFed" reads a bit awkwardly. Consider "Template for new features in DataFed" or "Template for adding new features to DataFed" for more natural wording.

```suggestion
about: Template for adding new features to DataFed
```
</issue_to_address>

### Comment 2
<location path=".github/ISSUE_TEMPLATE/feature-template.md" line_range="1" />
<code_context>
+---
+name: Feature Template
+about: Template for new features to DataFed
</code_context>
<issue_to_address>
**issue (bug_risk):** The repeated '---' blocks split the front matter in a way that may not parse correctly.

There are two separate `---` blocks around the template metadata, with an extra one before `type: feature`. GitHub issue templates expect a single front-matter block, so these should be merged into one to ensure correct parsing.
</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.

Combine GitHub's automated frontmatter yaml with custom frontmatter yaml
@infispiel infispiel merged commit 15a023f into master Feb 25, 2026
5 checks passed
@infispiel infispiel deleted the ci/feature-issue-template branch February 25, 2026 16:17
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