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

workflow: added issue-templates to organize issues #228

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ashrafchowdury
Copy link
Contributor

Description

Three types of issue templates have been implemented to provide a consistent structure for the issues created by the users. The issue templates include labels for bug, feature, and enhancement to aid issue filtering and searchability for contributors.

The 3 types of issue templates are:

  1. Bug Report
  2. Feature Request
  3. General Improvement

Changes

  1. Created a new folder named ISSUE_TEMPLATE under .github folder.
  2. Created 3 new .yml files for three different templates.

Issue

Closes #226

Copy link

vercel bot commented Jan 4, 2024

@ashrafchowdury is attempting to deploy a commit to the mftsio Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

what-the-diff bot commented Jan 4, 2024

PR Summary

  • Bug Report Template Creation
    A new issue template for bug reports has been created on Github to help streamline the process of reporting bugs. Some key fields added to the template include a space for the report name, the relevant labels, a description, required fields like a thorough problem statement, reproducible steps, and other useful details. This aims to ensure that users detail bugs as comprehensively as possible when making a report.

  • Feature Request Template Creation
    Similarly, this PR also includes a new issue template specifically geared towards feature requests. This will allow contributors to put forward their suggestions for new project enhancements more effectively. The template includes spaces for a title, description, use cases, additional context, and required validations to ensure the details about the suggested feature are thorough and useful.

  • General Improvement Template Creation
    Lastly, to allow users to suggest general improvements, an additional template has been included in this PR. Specific labels and descriptions guide the user in detailing their improvement suggestions by providing spaces for critical areas, such as describing the suggestion, its benefits, a proposed solution, if any, and additional context.

The inclusion of these templates is aimed at making bug reporting, feature suggesting and improvement proposing more efficient and effective across the project, and ensuring these processes produce comprehensive and valuable information.

@mfts
Copy link
Owner

mfts commented Jan 31, 2024

Thanks for this contribution. I'm not a huge fan of the issue templates just yet. It increases friction with such an young, contribution-growing project.

Let's revisit it later :)

@mfts mfts added the revisit Currently not required but important in the future label Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
revisit Currently not required but important in the future
Projects
None yet
Development

Successfully merging this pull request may close these issues.

⚒️ workflow: Implementing Issue Templates for improved Project Organization
2 participants