Skip to content

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

Merged
merged 7 commits into from
Dec 22, 2020
Merged

Conversation

RyanCavanaugh
Copy link
Member

Goals of this PR:

  • Make the repo more "welcoming" - yelling at people in the template isn't friendly, and doesn't seem to have affected behavior in any measurable sense
  • Make the templates less "wall-of-text"y by using markdown header sections and emoji to more clearly visually break apart each section
  • Reorder the sections to create a "funnel" that encourages people to do things in the right order (search, regress, then describe)
  • Add a new template for the common case of DOM/lib updates
  • Encourage filers to explicitly identify regressions, since we care a lot about these, and also funnels "has always been this way" bugs into the FAQ more explicitly rather than upfront

I removed the "related issues" since I have rarely found it to be useful.

@typescript-bot typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Dec 19, 2020
- 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
Copy link
Member

Choose a reason for hiding this comment

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

🏌🏻‍♂️

?

Copy link
Member Author

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

Comment on lines 67 to 71
### 🙂 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
Copy link
Member

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"

Copy link
Member Author

Choose a reason for hiding this comment

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

Agree; swapped

Comment on lines 54 to 59
## 📃 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?
-->
Copy link
Member

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.

Copy link
Member Author

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
Copy link
Member

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"?

Copy link
Member Author

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

@orta
Copy link
Contributor

orta commented Dec 22, 2020

Noting to self to update the version of this in the Playground once this is merged

@RyanCavanaugh RyanCavanaugh merged commit 22f452c into microsoft:master Dec 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants