Update GitHib issue forms

This commit is contained in:
Tyrrrz
2021-06-24 21:40:08 +03:00
parent 55d12dc721
commit df73a0bfe8
4 changed files with 47 additions and 12 deletions

View File

@@ -1,30 +1,42 @@
name: "\U0001F41E Bug report" name: 🐞 Bug report
description: Report broken functionality. description: Report broken functionality.
labels: [bug] labels: [bug]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
- Please check existing issues (both opened and closed) to ensure that this bug hasn't been reported before. 🧐 **Guidelines:**
- If you want to ask a question instead of reporting a bug, use [discussions](https://github.com/Tyrrrz/CliFx/discussions/new) instead.
- Search through [existing issues](https://github.com/Tyrrrz/CliFx/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/CliFx/discussions/new) instead.
- type: input - type: input
attributes: attributes:
label: Version label: Version
description: "Which version(s) of CliFx does this bug affect?" description: Which version of CliFx does this bug affect?
placeholder: ver X.Y.Z
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Details 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.
placeholder: I was doing X expecting Y to happen, but Z happened instead.
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Steps to reproduce label: Steps to reproduce
description: "Minimum steps or code required to reproduce the bug." description: Minimum steps required to reproduce the bug.
placeholder: |
- Step 1
- Step 2
- Step 3
validations: validations:
required: true required: true

View File

@@ -1,5 +1,5 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: "\U0001F5E8 Ask a question" - name: 🗨 Discussions
url: https://github.com/Tyrrrz/CliFx/discussions/new url: https://github.com/Tyrrrz/CliFx/discussions/new
about: Please ask and answer questions here. about: Ask and answer questions.

View File

@@ -1,16 +1,22 @@
name: "\U00002728 Feature request" name: Feature request
description: Request a new feature. description: Request a new feature.
labels: [enhancement] labels: [enhancement]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
- Please check existing issues (both opened and closed) to ensure that this feature hasn't been requested before. 🧐 **Guidelines:**
- If you want to ask a question instead of requesting a feature, use [**discussions**](https://github.com/Tyrrrz/CliFx/discussions/new) instead.
- Search through [existing issues](https://github.com/Tyrrrz/CliFx/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/CliFx/discussions/new) instead.
- type: textarea - type: textarea
attributes: attributes:
label: Details label: Details
description: "Clear and thorough explanation of the feature you have in mind." description: Clear and thorough explanation of the feature you have in mind.
validations: validations:
required: true 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