papermark icon indicating copy to clipboard operation
papermark copied to clipboard

workflow: added issue-templates to organize issues

Open ashrafchowdury opened this issue 2 years ago • 3 comments

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

ashrafchowdury avatar Jan 04 '24 05:01 ashrafchowdury

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

A member of the Team first needs to authorize it.

vercel[bot] avatar Jan 04 '24 05:01 vercel[bot]

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.

what-the-diff[bot] avatar Jan 04 '24 05:01 what-the-diff[bot]

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 avatar Jan 31 '24 07:01 mfts