Skip to content

.github/ISSUE_TEMPLATE: various formatting and typo fixes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rossphilipson merged 1 commit into from
Sep 15, 2020
Merged

.github/ISSUE_TEMPLATE: various formatting and typo fixes #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/bug-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: Bug report
about: 'Report a problem in existing functionality, including documentation and infrastructure.'
about: Report a problem in existing functionality, including documentation and infrastructure.
Copy link
Contributor

@dpsmith dpsmith Sep 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't looked at the other templates so it may be like this in them but why did you remove the quotes here but left them on the title, labels, and assignees fields?

Copy link
Member Author

@pietrushnic pietrushnic Sep 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dpsmith I just tried to be consistent across about sections for all templates, if we want to leave ' here then let's add those wherever those are missing. Please let me know what is your policy and I will correct it accordingly. TBH I'm not sure if it will cause any rendering issues.

Copy link
Contributor

@dpsmith dpsmith Sep 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries, at that point had not looked across the other templates. Honestly I don't think it matters and agree it likely does not affect rendering. I was more curious why some fields get quotes and others don't, which might be a question better for @rossphilipson. It might be as simple as an artifact from the templates that were borrowed from.

Copy link
Contributor

@rossphilipson rossphilipson Sep 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I am going to just take this to make everything consistent. If there are rendering issues I will PR a consistent use of using single quotes.

title: ''
labels: 'P: default, T: bug, W: todo'
assignees: ''

---

**Affected component(s) or functionality**
_The component or functionality of Trenchboot that is not working as expected._
_The component or functionality of TrenchBoot that is not working as expected._

**Brief summary**
_A clear and concise summary of the bug._
Expand Down Expand Up @@ -39,7 +39,9 @@ _Add any other context about the problem here._
_If applicable, any solutions or workarounds you've already tried._

**Relevant documentation you've consulted**
_A list of links to any relavant documentation you have consulted._
_A list of links to any relevant documentation you have consulted._

**Related, non-duplicate issues**
_A list of links to other bug reports, feature requests, or tasks in the trenchboot-issues tracker (or "none" if you didn't find any). Do not describe any other unreported bugs, features, or tasks here._
_A list of links to other bug reports, feature requests, or tasks in the
trenchboot-issues tracker (or "none" if you didn't find any). Do not describe
any other unreported bugs, features, or tasks here._
20 changes: 13 additions & 7 deletions .github/ISSUE_TEMPLATE/enhancement-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,28 @@ assignees: ''
---

**The problem you're addressing (if any)**
_A clear and concise description of the problem, if any, that this enhancement is intended to address._
_A clear and concise description of the problem, if any, that this enhancement
is intended to address._

**Describe the solution you'd like**
_If you have something in mind, a clear and concise description of what you want to happen. If you don't have something in mind, indicate as much._
_If you have something in mind, a clear and concise description of what you
want to happen. If you don't have something in mind, indicate as much._

**Where is the value to a user, and who might that user be?**
_Which users is this most likely to benefit? What user needs does this address? How might a user summarize this change or new thing?_
_Which users is this most likely to benefit? What user needs does this address?
How might a user summarize this change or new thing?_

**Describe alternatives you've considered**
_A clear and concise description of any alternative solutions or features you've considered._
_A clear and concise description of any alternative solutions or features
you've considered._

**Additional context**
_Add any other context or screenshots about the feature request here._

**Relevant documentation you've consulted**
_A list of links to any relavant documentation you have consulted._
_A list of links to any relevant documentation you have consulted._

**Related, [non-duplicate] issues**
_A list of links to other bug reports, feature requests, or tasks in the trenchboot-issues tracker. Do not describe any other unreported bugs, features, or tasks here._
**Related, non-duplicate issues**
_A list of links to other bug reports, feature requests, or tasks in the
trenchboot-issues tracker. Do not describe any other unreported bugs, features,
or tasks here._
8 changes: 5 additions & 3 deletions .github/ISSUE_TEMPLATE/feature-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ assignees: ''
---

**Is your feature request related to a problem? Please describe.**
_A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
_A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]_

**Is your feature request related to a new idea or technology that
would benefit the project? Please describe.**
Expand All @@ -19,10 +20,11 @@ benefit the project._
_A clear and 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 clear and concise description of any alternative solutions or features
you've considered._

**Additional context**
_Add any other context or screenshots about the feature request here._

**Relevant documentation you've consulted**
_A list of links to any relavant documentation you have consulted._
_A list of links to any relevant documentation you have consulted._
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/task.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ assignees: ''
---

**Affected component(s) or functionality (if applicable)**
_If applicable, the component or functionality of Trenchboot that this task concerns._
_If applicable, the component or functionality of TrenchBoot that this task
concerns._

**Brief summary**
_A clear and concise summary of the task that should be done._
Expand All @@ -20,7 +21,9 @@ _The version of the component or feature if available, otherwise NA._
_Add any other context about the problem here._

**Relevant documentation you've consulted**
_A list of links to any relavant documentation you have consulted._
_A list of links to any relevant documentation you have consulted._

**Related, non-duplicate issues**
_A list of links to other bug reports, feature requests, or tasks in the trenchboot-issues tracker. Do not describe any other unreported bugs, features, or tasks here._
_A list of links to other bug reports, feature requests, or tasks in the
trenchboot-issues tracker. Do not describe any other unreported bugs, features,
or tasks here._