Move issue/pull request templates to .github folder and split up

* Now that we have a .github folder we can have separate templates for bug
  reports and feature requests.
This commit is contained in:
baldurk
2020-06-12 13:40:02 +01:00
parent e0eb544529
commit 19c066c6fc
10 changed files with 97 additions and 50 deletions
+37
View File
@@ -0,0 +1,37 @@
---
name: Bug report
about: Report a bug or problem encountered while using RenderDoc
---
<!--
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
IF YOU DO NOT FOLLOW THE GUIDELINES, OR DO NOT USE THE TEMPLATE BELOW, YOUR ISSUE WILL BE CLOSED! NO EXCEPTIONS!
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
The template below shows what you need to include in a good bug report, and you MUST use it. More information in the docs:
https://github.com/baldurk/renderdoc/blob/v1.x/docs/CONTRIBUTING/Filing-Issues.md
I'm happy to help, but you have to ensure I fully understand what you want and have the information I need. If you're unsure, please read the guide above for full information on what is expected for filing issues.
-->
## Description
<!-- Here you can enter a description of what you are doing and what bug you are running into. -->
<!-- This is a good time to describe what you want to do, what is actually happening, and what you'd expect to happen instead. -->
## Steps to reproduce
<!-- Please list the steps that someone can take to reproduce the bug. -->
<!-- If you can share your capture or your application, PLEASE DO THAT NOW. It is by far the easiest way to demonstrate a bug. You can share it privately via email to baldurk@baldurk.org and mention it here. -->
<!-- If you cannot share because of privacy or other reasons, please state that and give as much extra information as you can. -->
<!-- Steps like "run my application" or "load this capture" are not useful unless you share the application or capture. Be specific! -->
## Environment
<!-- if you are running a nightly build, list the date or commit hash for the version -->
* RenderDoc version: XXX
* Operating System: XXX
* Graphics API: XXX
<!-- More details here never hurt! For example your GPU, driver version, etc. -->
+5
View File
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question
url: https://github.com/baldurk/renderdoc/blob/v1.x/docs/CONTRIBUTING/Questions.md
about: Github issues are not well suited for general questions. Please read about where to ask questions here.
+30
View File
@@ -0,0 +1,30 @@
---
name: Feature request
about: Suggest an improvement or new feature be added to RenderDoc
---
<!--
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
IF YOU DO NOT FOLLOW THE GUIDELINES, OR DO NOT USE THE TEMPLATE BELOW, YOUR ISSUE WILL BE CLOSED! NO EXCEPTIONS!
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
The template below shows what you need to include in a good feature request, and you MUST use it. More information in the docs:
https://github.com/baldurk/renderdoc/blob/v1.x/docs/CONTRIBUTING/Filing-Issues.md
I'm happy to help, but you have to ensure I fully understand what you want and have the information I need. If you're unsure, please read the guide above for full information on what is expected for filing issues.
-->
## Description
<!-- Here you should not just describe what feature you want. Please describe the context of what you are trying to do or what workflow you would like, and why you can't do that with RenderDoc today. -->
<!-- You can then separately describe a specific feature or solution you'd like to see to address that desire. -->
## Environment
<!-- if you are running a nightly build, list the date or commit hash for the version -->
* RenderDoc version: XXX
* Operating System: XXX
* Graphics API: XXX
<!-- You should still list the details here so that the scope of the request can be understood. -->
+19
View File
@@ -0,0 +1,19 @@
<!--
Before submitting a pull request you are strongly recommended to read the
docs/CONTRIBUTING.md file which gives some information on how to prepare a
change:
https://github.com/baldurk/renderdoc/blob/v1.x/docs/CONTRIBUTING.md
For small changes you don't have to read the document end to end, but should at
least look at the sections on how to ensure your code and commits are formatted
according to the style requirements.
-->
## Description
<!--
Describe here what your pull request changes and why it should happen. For small
changes which are obvious this can just be a line or two - even the commit
message is sometimes enough.
-->