From 0fd2acf774fcf1d354606a956216d3b114fba1b2 Mon Sep 17 00:00:00 2001 From: Eric Griswold Date: Wed, 10 Jul 2024 05:31:23 -0700 Subject: [PATCH] (maint) Issue Template Update I received a report in puppetlabs/puppetlabs-release that using an EOL operating system (Ubuntu 18) as an example had mildly bad optics, so I found the source of it here. My proposal is to not force ourselves to face this problem every now-and-then by removing the specific example but still attempting to have helpful text. Additionally, I don't feel the phrase 'clear and consise' is clear and concise, so I trimmed it along with bits of other verbiage in the hopes of making the templates themselves concise. --- .github/ISSUE_TEMPLATE/bug-report.md | 8 ++++---- .github/ISSUE_TEMPLATE/docs-change.md | 2 +- .github/ISSUE_TEMPLATE/feature-request.md | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index ec7ec1d..7cc4cbc 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,10 +7,10 @@ assignees: '' --- ## Describe the Bug -A clear and concise description of what the bug is. +A concise description of what the bug is. ## Expected Behavior -A clear and concise description of what you expected to happen. +A concise description of what you expected to happen. ## Steps to Reproduce Steps to reproduce the behavior: @@ -18,8 +18,8 @@ Steps to reproduce the behavior: 2. Click on '....' ## Environment - - Version [e.g. 1.27.0] - - Platform [e.g. Ubuntu 18.04] + - Product Version [example: 1.27.0] + - Platform [Linux Distribution & Version/MacOS version/Windows Version] ## Additional Context Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/docs-change.md b/.github/ISSUE_TEMPLATE/docs-change.md index 2513361..046aa56 100644 --- a/.github/ISSUE_TEMPLATE/docs-change.md +++ b/.github/ISSUE_TEMPLATE/docs-change.md @@ -7,4 +7,4 @@ assignees: '' --- ## Describe the Change You Would Like -A clear and concise description of what you would like changed. +A concise description of what you would like changed. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 9606063..9e87991 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,13 +7,13 @@ assignees: '' --- ## Use Case -A clear and concise description of what the problem you're trying to solve is. Ex. I'm always frustrated when [...] +A concise description of the problem. Example: I'm frustrated when [...] ## Describe the Solution You Would Like -A clear and concise description of what you want to happen. +A concise description of what you want to happen. ## Describe Alternatives You've Considered -A clear and concise description of any alternative solutions or features you've considered. +A concise description of any alternative solutions or features you've considered. ## Additional Context -Add any other context or screenshots about the feature request here. +Any other context or screenshots about the feature request.