Make it very clear if someone deletes a required section from template

baldurk · Oct 28, 2024 · db6e936 · db6e936
1 parent cf76de3
commit db6e936
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -17,7 +17,7 @@ For example this includes capturing commercial games that you did not create, or
 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
+## Description of Bug
 
 <!-- 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. -->

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -13,7 +13,7 @@ https://github.com/baldurk/renderdoc/blob/v1.x/docs/CONTRIBUTING/Filing-Issues.m
 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
+## Description of Feature
 
 <!-- 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. -->
 

diff --git a/docs/CONTRIBUTING/Filing-Issues-Bugs.md b/docs/CONTRIBUTING/Filing-Issues-Bugs.md
@@ -18,7 +18,7 @@ If you really want to go in-depth there is a lot of writing online about how to
 
 Below is guidance for each section of the issue template.
 
-# Description
+# Description of Bug
 
 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.
 

diff --git a/docs/CONTRIBUTING/Filing-Issues-Features.md b/docs/CONTRIBUTING/Filing-Issues-Features.md
@@ -4,7 +4,7 @@
 
 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
+# Description of Feature
 
 When writing the description of a feature request, it's important to describe what your end goal is. If you describe only what you think the solution should be then that makes it harder to understand what you're really after. This is often known as [the XY problem](http://xyproblem.info/). You can of course describe the solution you have in mind as well, just be sure not to _only_ describe that solution.