misc(github): add github PR and issue templates #5163
Conversation
underbyte
changed the title
There was a problem hiding this comment.
thanks so much for putting this together @underbyte! I think this will help contributors a lot 👍
.github/ISSUE_TEMPLATE.md
Outdated
| **Provide the steps to reproduce if this is a bug** | ||
|
|
||
|
|
||
| **Please mention other relevant information such as the browser version, Node.js version, Lighthouse version, and Operating System.** |
There was a problem hiding this comment.
Let's borrow from the bug report style below:
**Environment Information**:
Affected Channels:
- [ ] CLI
- [ ] Node Module
- [ ] Extension
- [ ] DevTools
Lighthouse version:
Node.js version:
Operating System:
| @@ -0,0 +1,21 @@ | |||
| --- | |||
| name: Feature request | |||
There was a problem hiding this comment.
From what I understand these will only be used if you append ?template=Feature_request.md to the new issue URL?
If so, I'm not sure we have a use case for the specific issue templates just yet. Maybe we should just start with global issue template.
There was a problem hiding this comment.
Yes, it does change the URL but you also get this (at least, if I understand it right).
There was a problem hiding this comment.
Oh that's awesome!! They should add that to the post 😆
Do we need the global one then if you always get this option?
There was a problem hiding this comment.
BTW where did that screenshot come from?
There was a problem hiding this comment.
The SS came from webpack repo LINK.
Think the global one would be nice to have? Wouldn't hurt to keep it around.
There was a problem hiding this comment.
Think the global one would be nice to have? Wouldn't hurt to keep it around.
I'm mainly just thinking about keeping them in sync since they already seem to differ a bit :) it's not a biggie
There was a problem hiding this comment.
Ya let's nuke the global issue template. The specific ones are good 'nuff.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| <!-- Link any documentation or information that would help understand this change --> | ||
|
|
||
| **Other information** |
There was a problem hiding this comment.
WDYT about changing this into **Related Issues/PRs** we frequently end up linking blocking PRs/closing issues/etc
Other seems like something one can always add on their own :)
There was a problem hiding this comment.
Sounds good to me!
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| <!-- If this is a bug report use this portion of the template and delete the feature request portion --> | ||
|
|
||
| **Describe the *bug* issue** |
There was a problem hiding this comment.
I like this set of questions! WDYT about adding one about relevant existing issues?
<!-- Have you searched for similar open issues? -->
<!-- If yours is a duplicate, consider commenting with additional info or +1'ing instead. -->
Related issues: <!-- #9000 -->or something
.github/ISSUE_TEMPLATE.md
Outdated
| **What is the expected behavior?** | ||
|
|
||
|
|
||
| **Provide the steps to reproduce if this is a bug** |
There was a problem hiding this comment.
we've already established this is the bug part so let's just say Provide the steps to reproduce
.github/ISSUE_TEMPLATE.md
Outdated
| **What is motivation or use case for changing this?** | ||
|
|
||
|
|
||
| **Please mention other relevant information such as the browser version, Node.js version, Lighthouse version, and Operating System.** |
There was a problem hiding this comment.
we can probably just ask where they want the feature (CLI/DevTools/Extension/Node Module)
.github/ISSUE_TEMPLATE.md
Outdated
| <!-- Before creating an issue please make sure you are using the latest version. --> | ||
|
|
||
| <!-- If this is a feature request use this portion of the template and delete the bug portion --> | ||
| **Describe the *feature* request** |
There was a problem hiding this comment.
We also have a process for new audits we can reference https://github.com/GoogleChrome/lighthouse/blob/master/docs/new-audits.md
There was a problem hiding this comment.
went ahead and added this to the feature request template
|
@patrickhulce Think I got everything. Let me know if anything else is missing. |
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
| <!-- Have you searched for similar open issues? --> | ||
| <!-- If yours is a duplicate, consider commenting with additional info or +1'ing instead. --> | ||
| Related issues: <!-- #9000 --> |
There was a problem hiding this comment.
oops my proposal seems to be out of style a bit with the rest of yours. let's match it up to what you've got here I like that more :)
**Related issues**
There was a problem hiding this comment.
Latest commit, I delete the issue template and added your last two feedback to the bug report.
.github/ISSUE_TEMPLATE.md
Outdated
|
|
||
|
|
||
| **Provide the steps to reproduce** | ||
|
|
There was a problem hiding this comment.
Let's add a placeholder step for the URL since that's almost always the first question we ask
1. Run LH on <affected url>
|
Hey @patrickhulce, anything left on this PR? |
Feature request
Summary of the feature request?
Github supports these templates to help standardize contribution into repository. Whenever I'm filing a ticket/PR having these templates help in the writing process. What submitted here are heavily inspired by the webpack community; more possible format can be found here.
What is the motivation or use case for changing this?
To help standardize the format for writing PR/issue tickets.
How is this beneficial to Ligthhouse?
Help make it easier for people to contribute via PR/issue tickets.