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: Implementing Issue Templates for improved Project Organization #226

Open
ashrafchowdury opened this issue Jan 3, 2024 · 3 comments · May be fixed by #228
Open

⚒️ workflow: Implementing Issue Templates for improved Project Organization #226

ashrafchowdury opened this issue Jan 3, 2024 · 3 comments · May be fixed by #228

Comments

@ashrafchowdury
Copy link
Contributor

Description

I'd like to propose the implementation of issue templates. Currently, when creating new issues, the process can be inconsistent and lack crucial information, leading to confusion and delays in resolution. Issue templates would provide a structured approach to reporting issues, ensuring all necessary details are captured and streamlining the workflow for both reporters and contributors.

Proposed approach:

  1. Identify common issue types: We can start by brainstorming the most frequent types of issues encountered in the project (e.g., bugs, feature requests, documentation errors).
  2. Develop template drafts: For each identified type, create a dedicated template with relevant sections prompting for important details (e.g., description, steps to reproduce, screenshots).

Examples

This example is from Documenso Issue templates

image

@ashrafchowdury
Copy link
Contributor Author

I would like to work on it if all sounds good. 👍💖

@sourabpramanik
Copy link

@mfts I think we can have similar flow if it aligns

Great proposal @ashrafchowdury

@mfts
Copy link
Owner

mfts commented Mar 17, 2024

Thanks @ashrafchowdury, while I like issue and pr templates, it's sometimes daunting for users who face an issue but don't know how to fill out the entire form, therefore opt to not report an issue at all.

We are not getting a massive influx of issues yet, therefore holding off on adding a template :)

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 a pull request may close this issue.

3 participants