diff --git a/docs/CONTRIBUTING/Filing-Issues-Bugs.md b/docs/CONTRIBUTING/Filing-Issues-Bugs.md index 2f78ad0ab..d6fbcfcc4 100644 --- a/docs/CONTRIBUTING/Filing-Issues-Bugs.md +++ b/docs/CONTRIBUTING/Filing-Issues-Bugs.md @@ -2,6 +2,10 @@ Sorry that you've run into a bug! I'd like to be able to fix it, but first you need to fill out a good bug report to ensure I can understand the problem. +: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. + # 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. @@ -16,16 +20,13 @@ Below is guidance for each section of the issue template. # Description -In the description section you can explain what kind of problem you're running into. The golden rule for this is: - -1. Describe what you see actually happening. -2. Describe what you'd expect to see instead. +In the description section you can explain what kind of problem you're running into. The golden rule for this is to describe what you actually see happening, and then describe what you'd expect to see instead. The point here is to make it clear to anyone what the bug is, because unless you describe it not everyone may understand what the problem is. If you describe what you're trying to do and where the problem arises, compared to what you would expect to happen if everything worked, it's easier to understand. -This is mostly relevant for bugs where something doesn't behave right rather than if something crashes where it's clear what is going wrong. +This is mostly relevant for bugs where something doesn't behave right rather than if something crashes where it's clear what is going wrong, but it's still useful information. -# Repro steps +# Steps to reproduce This section is the most important one! @@ -43,10 +44,8 @@ If you cannot share your capture or application even privately, then that's unde # Environment -Please update the environment section to at least list the main three items: +Please update the environment section for at least the three items present, the RenderDoc version you are using, your OS, and the graphics API(s) that you are seeing the bug on. -1. The RenderDoc version you are using (including the date or commit hash for nightly builds) -2. Your OS, such as Windows 7, Ubuntu, Android, Windows 10 -3. The graphics API where you can reproduce this bug. +For the RenderDoc version if you're using a nightly build include the date or commit hash for that nightly build, since the v1.X number is not unique. Giving more details here such as your GPU and driver version can't hurt, but you must include the three above since this gives important information about where the problem might be. diff --git a/docs/CONTRIBUTING/Filing-Issues-Features.md b/docs/CONTRIBUTING/Filing-Issues-Features.md index d949b1672..a6ed8bad2 100644 --- a/docs/CONTRIBUTING/Filing-Issues-Features.md +++ b/docs/CONTRIBUTING/Filing-Issues-Features.md @@ -2,6 +2,8 @@ (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. # Description @@ -14,7 +16,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. -# Repro Steps +# 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 :). diff --git a/docs/CONTRIBUTING/Filing-Issues.md b/docs/CONTRIBUTING/Filing-Issues.md index 6554ae085..b86a02998 100644 --- a/docs/CONTRIBUTING/Filing-Issues.md +++ b/docs/CONTRIBUTING/Filing-Issues.md @@ -2,7 +2,11 @@ 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. -This document is mostly split into two parts - first for bug reports, and second for feature requests or general questions. +:warning: **PLEASE NOTE: YOU MUST USE THE 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. + +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. 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. diff --git a/docs/issue_template.md b/docs/issue_template.md index 943dcfbe2..e0fd08c27 100644 --- a/docs/issue_template.md +++ b/docs/issue_template.md @@ -1,12 +1,8 @@ -**IF YOU DO NOT FOLLOW THE GUIDELINES, YOUR ISSUE WILL BE CLOSED** + ## Description @@ -16,7 +12,7 @@ Here you can enter a description of either the bug that you are encountering, or --> -## Repro steps +## Steps to reproduce