-
Notifications
You must be signed in to change notification settings - Fork 12.9k
Update issue templates #42049
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.
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
Update issue templates #42049
Conversation
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about _________ | ||
- I was unable to test this on prior versions because _______ | ||
|
||
### ⏯ Playground Link |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🏌🏻♂️
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had to zoom my display way in to parse that emoji
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
### 🙂 Expected behavior | ||
|
||
**Actual behavior:** | ||
<!-- What you expected to happen, and why --> | ||
|
||
**Playground Link:** <!-- A link to a TypeScript Playground "Share" link which demonstrates this behavior --> | ||
### 🙁 Actual behavior |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually kind of always disliked the ordering because what I tend to do is follow the template, and I want to just paste in the existing behavior. That means I have to jump down to the "actual behavior" section first, massage that, and then copy/paste that into the "expected behavior" section. I'd love if we were open to switching to "Current Behavior" followed by "Expected Behavior" or "Proposed Behavior"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree; swapped
## 📃 Motivating Example | ||
|
||
<!-- | ||
If you were announcing this feature in a blog post, what's a short explanation that shows | ||
a developer why this feature improves the language? | ||
--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd tend to suggest that motivation comes first - this is really the way I expect to read about features as a user, and it's the way that our team considers features. A new proposal should consider that first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree
|
||
<!-- A summary of what you'd like to see added or changed --> | ||
|
||
## 💻 Use Cases |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there much of a difference between "Use Cases" and "Motivating Example"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like having more places for people to provide color
Co-authored-by: Daniel Rosenwasser <[email protected]>
Co-authored-by: Daniel Rosenwasser <[email protected]>
Co-authored-by: Daniel Rosenwasser <[email protected]>
Co-authored-by: Daniel Rosenwasser <[email protected]>
Co-authored-by: Daniel Rosenwasser <[email protected]>
Noting to self to update the version of this in the Playground once this is merged |
Goals of this PR:
I removed the "related issues" since I have rarely found it to be useful.