[GH-ISSUE #611] [Improvement] - Improve the issue templates with issue forms (supported via yml) #168

Closed
opened 2026-02-26 18:45:40 +03:00 by kerem · 4 comments
Owner

Originally created by @sachinmmane on GitHub (Oct 30, 2023).
Original GitHub issue: https://github.com/documenso/documenso/issues/611

Originally assigned to: @sachinmmane on GitHub.

Improvement Description

GitHub supports the issue forms. This improvement allows users to create issues using a structured and visually appealing form. This functionality is facilitated through a yml file for the issue template.

Below, you'll find an example of an existing issue template and another example of the same template after integrating the new yml file.


Existing Issue Template for Bug Report


New Issue Template

Rationale

This change will improve the user experience of creating the GitHub issue for users. They will see an nice form to raise a GitHub issue.

Checklist

  • I have searched the existing issues and improvement suggestions to avoid duplication.
  • I have provided a clear description of the improvement being suggested.
  • I have explained the rationale behind this improvement.
  • I have included any relevant technical details or design suggestions.
  • I understand that this is a suggestion and that there is no guarantee of implementation.
Originally created by @sachinmmane on GitHub (Oct 30, 2023). Original GitHub issue: https://github.com/documenso/documenso/issues/611 Originally assigned to: @sachinmmane on GitHub. <!--- Please provide a clear and concise title for your improvement suggestion --> ## Improvement Description GitHub supports the [issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms). This improvement allows users to create issues using a structured and visually appealing form. This functionality is facilitated through a `yml` file for the issue template. Below, you'll find an example of an existing issue template and another example of the same template after integrating the new `yml` file. ---------------------------------------- **Existing Issue Template for Bug Report** ![](https://user-images.githubusercontent.com/54999683/279059613-e96eab11-25fe-4b68-98e2-3e57bad4a6b8.png) ---------------------------------------- **New Issue Template** ![](https://user-images.githubusercontent.com/54999683/279060279-a572a71b-4f71-4ba6-b27f-d4c0ef807a3a.png) ## Rationale This change will improve the user experience of creating the GitHub issue for users. They will see an nice form to raise a GitHub issue. <!--- Explain why this improvement would be beneficial. --> <!--- Share any context, pain points, or reasons for suggesting this change. --> ## Checklist <!--- Please check the boxes that apply to this improvement suggestion. --> <!--- You can add or remove items as needed. --> - [x] I have searched the existing issues and improvement suggestions to avoid duplication. - [x] I have provided a clear description of the improvement being suggested. - [x] I have explained the rationale behind this improvement. - [x] I have included any relevant technical details or design suggestions. - [x] I understand that this is a suggestion and that there is no guarantee of implementation.
kerem 2026-02-26 18:45:40 +03:00
  • closed this issue
  • added the
    community
    label
Author
Owner

@sachinmmane commented on GitHub (Oct 30, 2023):

This improvement is hande in the following pull request https://github.com/documenso/documenso/pull/612.

Live Demo

The live preview of this change and issue templates can be found here
https://github.com/sachinmmane/documenso/issues/new/choose

<!-- gh-comment-id:1785577478 --> @sachinmmane commented on GitHub (Oct 30, 2023): This improvement is hande in the following pull request https://github.com/documenso/documenso/pull/612. ## Live Demo The live preview of this change and issue templates can be found here https://github.com/sachinmmane/documenso/issues/new/choose
Author
Owner

@catalinpit commented on GitHub (Oct 31, 2023):

Dang, this is really neat! Thanks for this suggestion, @sachinmmane!

I've also seen that you opened a PR for this. We recently updated the contribution guide, which states that you should Comment on the issue with your intention to work on it and get it assigned to you before starting to work on it.

The reason for this update is to bring more order and improve the contribution process.

IMG_7832
Source: Contribution Guide #taking-issues

<!-- gh-comment-id:1786539886 --> @catalinpit commented on GitHub (Oct 31, 2023): Dang, this is really neat! Thanks for this suggestion, @sachinmmane! I've also seen that you opened a PR for this. We recently updated the contribution guide, which states that you should `Comment on the issue with your intention to work on it` and get it assigned to you before starting to work on it. The reason for this update is to bring more order and improve the contribution process. ![IMG_7832](https://github.com/documenso/documenso/assets/25515812/dd3e9fda-5d04-4436-9ab4-86aa715ad773) *Source: [Contribution Guide #taking-issues](https://github.com/documenso/documenso/blob/feat/refresh/CONTRIBUTING.md#taking-issues)*
Author
Owner

@Mythie commented on GitHub (Nov 2, 2023):

Solved as per #612

<!-- gh-comment-id:1790335619 --> @Mythie commented on GitHub (Nov 2, 2023): Solved as per #612
Author
Owner

@sachinmmane commented on GitHub (Nov 3, 2023):

Thank you @catalinpit for your comment. Sure, I will take care of it in my future contributions.

<!-- gh-comment-id:1792121907 --> @sachinmmane commented on GitHub (Nov 3, 2023): Thank you @catalinpit for your comment. Sure, I will take care of it in my future contributions.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/documenso#168
No description provided.