docs: create issue templates #282
Conversation
lazd
force-pushed
the
issue-templates
branch
from
310df1a to
b0ac60a
Compare
|
maybe move all of the example descriptions you added in a comments block so there is never a chance it get's added to the PR by accident. |
There was a problem hiding this comment.
seeing a lot of inconsistencies with comment blocks for the templates.
I'd suggest to always use the comment blocks <!-- --> to avoid the accidental adding of template text.
I would also suggest that our content strategist Jess takes a look at this. She might have very valuable feedback.
| @@ -0,0 +1,36 @@ | |||
| --- | |||
| name: "🐛Bug report" | |||
| about: Report a problem with Spectrum CSS | |||
There was a problem hiding this comment.
Maybe just "report a bug"
There was a problem hiding this comment.
It renders like this, so I think Bug report with the description works well here:
There was a problem hiding this comment.
ah cool to see the context! this might make it more consistent.
|
|
||
|
|
||
| ## Steps to reproduce | ||
|
|
There was a problem hiding this comment.
maybe something like URL?
Those will be very useful.
There was a problem hiding this comment.
Agreed. That's what I meant with Go to '...', I will make that more clear
There was a problem hiding this comment.
you could pre-fill a URL in markdown there [URL](https://adobe.com) and make it even easier.
| @@ -0,0 +1,20 @@ | |||
| --- | |||
| name: "✨Feature request" | |||
| about: Suggest an idea for this project | |||
There was a problem hiding this comment.
Agreed, idea seems a bit out of place.
|
|
||
| --- | ||
|
|
||
| ## Is your feature request related to a problem? |
There was a problem hiding this comment.
why describe it as a question? Is this a check for them?
Why not "## Feature description"
There was a problem hiding this comment.
Yeah, I borrowed github's default template here... I thought this was a little weird as well. I'm +1 for Describe the feature in detail and any related problems it solves
| ## Is your feature request related to a problem? | ||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
|
||
| ## Describe the solution you'd like |
There was a problem hiding this comment.
kind of the same like "Feature description"
| ## Describe the solution you'd like | ||
| A clear and concise description of what you want to happen. | ||
|
|
||
| ## Describe alternatives you've considered |
There was a problem hiding this comment.
why would you need to describe alternatives?
There was a problem hiding this comment.
This would be something like
Currently, I have to do step 1 and step 2 to achieve my goal, but with this feature, it would be only one step
| ## Describe alternatives you've considered | ||
| A clear and concise description of any alternative solutions or features you've considered. | ||
|
|
||
| ## Additional context |
There was a problem hiding this comment.
maybe ## Additional context and screenshots
There was a problem hiding this comment.
I think the line below covers screenshots, I'll make it a comment like the other files.
|
I just got final sign-off from Jess in content strategy on these templates. @bernhard-adobe, can you merge this? |
Description
This PR adds issue templates:
Related Issues
Motivation and Context
This will streamline issue reporting.
How Has This Been Tested?
We have to merge to master first before testing.