From db6e93665fc0eadd67320f6e3037c3c0d79c0b0d Mon Sep 17 00:00:00 2001 From: baldurk Date: Mon, 28 Oct 2024 10:25:50 +0000 Subject: [PATCH] Make it very clear if someone deletes a required section from template --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- docs/CONTRIBUTING/Filing-Issues-Bugs.md | 2 +- docs/CONTRIBUTING/Filing-Issues-Features.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ef3caf6cd8..e15da56ab2 100644 --- 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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index a972d61874..6ca5719558 100644 --- 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 diff --git a/docs/CONTRIBUTING/Filing-Issues-Bugs.md b/docs/CONTRIBUTING/Filing-Issues-Bugs.md index 5e03680691..a8eaea72c7 100644 --- 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 index 825984de04..cb527533b3 100644 --- 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.