Refactor issue forms and add pull request template

This commit is contained in:
Tyrrrz 2021-06-24 19:23:39 +03:00
parent 5b5a53dbf4
commit 79a9ac0462
6 changed files with 77 additions and 77 deletions

View file

@ -1,27 +1,30 @@
name: "\U0001F41E Bug report"
name: 🐞 Bug report
description: Report broken functionality.
labels: [bug]
body:
- type: markdown
attributes:
value: |
Important:
🧐 **Guidelines:**
- Please check existing issues (both opened and closed) to ensure that this bug hasn't been reported before.
- Refer to the [contribution guidelines](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/Contributing.md) for info on how to file a good issue.
- Search through [existing issues](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) first to ensure that this bug has not been reported before.
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems".
- Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them.
- Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant.
- If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
- type: input
attributes:
label: Version
description: "Which version(s) of DiscordChatExporter does this bug affect?"
description: "Which version of DiscordChatExporter does this bug affect?"
validations:
required: true
- type: dropdown
attributes:
label: Flavor
description: "Which flavor(s) of DiscordChatExporter does this bug affect?"
description: "Does this bug affect the GUI version, the CLI version, or both?"
multiple: true
options:
- GUI (Graphical User Interface)
@ -32,7 +35,7 @@ body:
- type: dropdown
attributes:
label: Export format
description: "Which export format(s) does this bug affect? If this bug is not related to any specific export format, leave this blank."
description: "Does this bug affect specific export format(s)? If not applicable, leave this field blank."
multiple: true
options:
- HTML
@ -43,7 +46,7 @@ body:
- type: textarea
attributes:
label: Details
description: "Clear and thorough explanation of the bug. If relevant, include screenshots or screen recordings."
description: "Clear and thorough explanation of the bug."
validations:
required: true
@ -51,5 +54,9 @@ body:
attributes:
label: Steps to reproduce
description: "Minimum steps required to reproduce the bug."
placeholder: |
- Step 1
- Step 2
- Step 3
validations:
required: true

View file

@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: "\U0001F4D6 Read the wiki"
- name: 📖 Wiki
url: https://github.com/Tyrrrz/DiscordChatExporter/wiki
about: Find answers to most common questions.
- name: "\U0001F5E8 Ask a question"
about: Find usage guides and frequently asked questions.
- name: 🗨 Discussions
url: https://github.com/Tyrrrz/DiscordChatExporter/discussions/new
about: Please ask and answer questions here.
about: Ask and answer questions.

View file

@ -1,20 +1,23 @@
name: "\U00002728 Feature request"
name: ✨ Feature request
description: Request a new feature.
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Important:
🧐 **Guidelines:**
- Please check existing issues (both opened and closed) to ensure that this feature hasn't been requested before.
- Refer to the [contribution guidelines](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/Contributing.md) for info on how to file a good issue.
- Search through [existing issues](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) first to ensure that this feature has not been requested before.
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Some suggestions" or "Ideas for improvement".
- Keep your issue focused on one single problem. If you have multiple feature requests, please create separate issues for each of them.
- Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant.
- If you want to ask a question instead of requesting a feature, please use [discussions](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
- type: dropdown
attributes:
label: Flavor
description: "Which flavor(s) of DiscordChatExporter does this feature request apply to? If this feature is not related to any specific flavor, leave this blank."
description: "Is this feature request related to specific flavor(s) of DiscordChatExporter? If not applicable, leave this field blank."
multiple: true
options:
- GUI (Graphical User Interface)
@ -23,7 +26,7 @@ body:
- type: dropdown
attributes:
label: Export format
description: "Which export format(s) does this feature request apply to? If this feature is not related to any specific export format, leave this blank."
description: "Is this feature request related to specific export format(s)? If not applicable, leave this field blank."
multiple: true
options:
- HTML
@ -34,6 +37,6 @@ body:
- type: textarea
attributes:
label: Details
description: "Clear and thorough explanation of the feature you have in mind. If relevant, include screenshots or screen recordings."
description: "Clear and thorough explanation of the feature you have in mind."
validations:
required: true

17
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,17 @@
<!--
**Important:**
Please make sure that there is an existing issue that describes the problem solved by your pull request. If there isn't one, consider creating it first.
An open issue offers a good place to iron out requirements, discuss possible solutions, and ask questions.
Remember to also:
- Keep your pull request focused and as small as possible. If you want to contribute multiple unrelated changes, please create separate pull requests for them.
- Follow the coding style and conventions already established by the project. When in doubt about which style to use, ask in the comments to your pull request.
- If you want to start a discussion regarding a specific change you've made, add a review comment to your own code. This can be used to highlight something important or to seek further input from others.
-->
<!-- Please specify the issue addressed by this pull request -->
Closes #ISSUE_NUMBER