search

mfts / papermark

Papermark is the open-source DocSend alternative with built-in analytics and custom domains.
https://papermark.io
GNU Affero General Public License v3.0
5.34k stars 725 forks source link

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

Open ashrafchowdury opened 9 months ago

ashrafchowdury commented 9 months ago

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 commented 9 months ago

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

sourabpramanik commented 9 months ago

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

Great proposal @ashrafchowdury

mfts commented 7 months ago

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 :)