mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 17:10:47 +00:00
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
@@ -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. -->
|
||||
@@ -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.
|
||||
@@ -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. -->
|
||||
@@ -1,7 +1,9 @@
|
||||
<!--
|
||||
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.
|
||||
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
|
||||
@@ -31,6 +31,7 @@ You also agree by submitting your code that you grant all transferrable rights t
|
||||
5. [Testing](CONTRIBUTING/Testing.md)
|
||||
6. [Code Explanation](CONTRIBUTING/Code-Explanation.md)
|
||||
7. [Filing issues](CONTRIBUTING/Filing-Issues.md)
|
||||
8. [Asking Questions](CONTRIBUTING/Questions.md)
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
||||
@@ -4,15 +4,15 @@ Sorry that you've run into a bug! I'd like to be able to fix it, but first you n
|
||||
|
||||
:warning: **PLEASE NOTE: YOU MUST USE THE PROVIDED ISSUE TEMPLATE!** :warning:
|
||||
|
||||
This document explains the sections in the issue template and what you should put in them.
|
||||
When filing a bug please click 'Get started' next to the 'Bug report' entry. This document explains the sections in the issue template and what you should put in them.
|
||||
|
||||
# General guidance
|
||||
|
||||
It's extremely rare that you can provide too much information, and by comparison it's quite common to provide too little information. The more information you can provide the better I can determine the bug.
|
||||
You can't provide too much information, and it's quite common to provide too little information. The more information you can provide the better I can determine the bug.
|
||||
|
||||
Avoid the temptation to guess or assume what the problem is based on what you're seeing, unless you have dived into the code to find out. While it's not impossible it's probably not the case that RenderDoc crashes if you read a texture in a pixel shader. Most graphics programs do that! It's probably something more specific than that which is hard to identify without debugging. It's fine not to know what the problem is, that's my job! Just give as much information as possible.
|
||||
Avoid the temptation to guess or assume what the problem is based on what you're seeing, unless you have dived into the code to find out. It's probably not the case that RenderDoc crashes if you read a texture in a pixel shader. Most graphics programs do that! It's probably something more specific than that which is hard to identify without debugging. It's fine not to know what the problem is because that's my job! Just give as much information as possible.
|
||||
|
||||
If you have time, testing the latest nightly build of RenderDoc is a good idea since the bug you're reporting may have been fixed already. If the problem you're seeing is new and wasn't present in an older version of RenderDoc, it would be extremely helpful to know approximately when the problem started. You can download any historical nightly build to test with.
|
||||
If you have time, testing the latest nightly build of RenderDoc is a good idea since the bug you're reporting may have been fixed already. It's also a good idea to update your graphics drivers as some problems are caused by out of date drivers. If the problem you're seeing is new and wasn't present in an older version of RenderDoc, it would be extremely helpful to know approximately when the problem started. You can download any historical nightly build to test with.
|
||||
|
||||
If you really want to go in-depth there is a lot of writing online about how to make good bug reports! The classic that covers a lot is [Asking smart questions](http://www.catb.org/esr/faqs/smart-questions.html).
|
||||
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
# Filing feature requests
|
||||
|
||||
(also applies to general questions)
|
||||
|
||||
:warning: **PLEASE NOTE: YOU MUST USE THE PROVIDED ISSUE TEMPLATE!** :warning:
|
||||
|
||||
Below is guidance for each section of the issue template.
|
||||
When filing a bug please click 'Get started' next to the 'Feature request' entry. Below is guidance for each section of the issue template.
|
||||
|
||||
# Description
|
||||
|
||||
@@ -16,9 +14,7 @@ This can also be a reason why feature requests are turned down. If the problem y
|
||||
|
||||
If this happens please be aware that it's not a criticism of your use case, and if your change is small or you feel adventurous you could change RenderDoc's source and recompile it to behave as you'd like.
|
||||
|
||||
# Steps to reproduce
|
||||
|
||||
You can delete this section in the issue template! It is only required for bugs. However if you want to upload a capture to exhibit exactly what problem you're trying to solve that would be very welcome :).
|
||||
If you can upload a capture that exhibits exactly what problem you're trying to solve that would be very welcome :smile:.
|
||||
|
||||
# Environment
|
||||
|
||||
|
||||
@@ -2,16 +2,18 @@
|
||||
|
||||
Thanks for taking the time to look at the guidelines for filing issues! I'm happy to help out with your issue, but badly formatted or poorly described bug reports take too much time to untangle so it's your responsibility to give me the best possible chance to know what I need to fix.
|
||||
|
||||
:warning: **PLEASE NOTE: YOU MUST USE THE PROVIDED ISSUE TEMPLATE!** :warning:
|
||||
:warning: **PLEASE NOTE: YOU MUST USE THE RELEVANT PROVIDED ISSUE TEMPLATE!** :warning:
|
||||
|
||||
Using the template lets me know that you know what to include in a well-formatted issue and it shows the needed information at a glance. The template is not complicated and can be filled out easily.
|
||||
Using the template lets me know that you know what to include in a well-formatted issue and it shows the needed information at a glance. The template is not complicated and can be filled out easily. If you do not use the template, your issue will be closed.
|
||||
|
||||
This document explains what is expected in the template and is split into two parts - first for bug reports, and second for feature requests or general questions.
|
||||
Please use the bug report template when filing an issue about a bug or a crash, and only use the feature request template when requesting a new feature be added.
|
||||
|
||||
This document explains what is expected in the template and is split into two parts - first for bug reports, and second for feature requests.
|
||||
|
||||
As a general rule for all issues: Please be aware that RenderDoc is a tool for debugging your programs, not for copyright infringement. If your problem or request relates to violating copyright by extracting assets or injecting into copyrighted applications that are not your own then you will find no help here.
|
||||
|
||||
To read more about how to file an issue click the appropriate link below:
|
||||
|
||||
1. [Filing a bug](Filing-Issues-Bugs.md)
|
||||
2. [Requesting a feature or asking a question](Filing-Issues-Features.md)
|
||||
2. [Requesting a feature](Filing-Issues-Features.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# Asking questions
|
||||
|
||||
Sometimes you have a general question that you'd like to ask which isn't exactly a bug or a feature request.
|
||||
|
||||
In these cases, filing an issue on github isn't generally the best way to do it since questions might turn into a conversation or a discussion and don't have a defined scope.
|
||||
|
||||
Instead these questions can be asked in one of RenderDoc's community spaces, such as in [#renderdoc on freenode IRC](https://kiwiirc.com/client/irc.freenode.net/#renderdoc) or on RenderDoc's [Discord server](https://discord.gg/ahq6yRB). If your question is more private you can [email me directly at baldurk@baldurk.org](mailto:baldurk@baldurk.org).
|
||||
|
||||
Please note that in all these places RenderDoc's [code of conduct](../CODE_OF_CONDUCT.md) still applies.
|
||||
@@ -1,35 +0,0 @@
|
||||
<!-- IF YOU DO NOT FOLLOW THE GUIDELINES, OR DO NOT USE THE TEMPLATE BELOW, YOUR ISSUE WILL BE CLOSED! THIS APPLIES FOR BUG REPORTS AND FEATURE REQUESTS, NO EXCEPTIONS!
|
||||
|
||||
The template below shows what you need to include in a good bug report, and you must use it. Feature requests don't need to include 'steps to reproduce' but the description and environment provide good context. More information is available in the documentation: 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 either the bug that you are encountering, or the feature/improvement you'd like to see happen.
|
||||
|
||||
-->
|
||||
|
||||
## Steps to reproduce
|
||||
|
||||
<!--
|
||||
|
||||
If you're only requesting a feature you can delete this section.
|
||||
|
||||
For bug reports please describe the steps you can take to show the bug, in a way that I can follow them.
|
||||
|
||||
If you are able to share a capture, or your application, PLEASE DO THAT NOW because that is by far the easiest way to show a bug. If you cannot share because of privacy or other reasons, please say that and give as much extra information as you can.
|
||||
|
||||
-->
|
||||
|
||||
## 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. -->
|
||||
Reference in New Issue
Block a user