Skip to content
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

Jump to bottom

misc(github): add github PR and issue templates #5163

Merged
merged 5 commits into from
May 21, 2018
Merged

misc(github): add github PR and issue templates #5163

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b618cc8
contrib(github): add github PR and issue templates
underbyte May 9, 2018
ecf9b5f
fixes PR review feedback
underbyte May 15, 2018
f683162
del issue template and added more text to bug report
underbyte May 17, 2018
edab738
bug template tweaks
patrickhulce May 21, 2018
556590e
tweak
patrickhulce May 21, 2018
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
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!-- 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 -->
<!-- If this is a new audit please review the audit doc https://github.com/GoogleChrome/lighthouse/blob/master/docs/new-audits.md -->
**Describe the *feature* request.**


**What is motivation or use case for changing this?**


**Where should this feature be implemented (CLI/DevTools/Extension/Node Module)?**


<!-- If this is a bug report use this portion of the template and delete the feature request portion -->

**Describe the *bug* issue**
Copy link
Collaborator

Choose a reason for hiding this comment

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

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



<!-- Have you searched for similar open issues? -->
<!-- If yours is a duplicate, consider commenting with additional info or +1'ing instead. -->
Related issues: <!-- #9000 -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

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**

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Latest commit, I delete the issue template and added your last two feedback to the bug report.


**What is the current behavior?**


**What is the expected behavior?**


**Provide the steps to reproduce**

Copy link
Collaborator

Choose a reason for hiding this comment

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

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>


**Environment Information**:
Affected Channels:
- [ ] CLI
- [ ] Node Module
- [ ] Extension
- [ ] DevTools

Lighthouse version:
Node.js version:
Operating System:
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: File an issue ticket to help us improve

---

<!-- Before creating an issue please make sure you are using the latest version. -->

# Bug report

**What is the current behavior?**


**Provide the steps to reproduce.**


**What is the expected behavior?**


**Environment Information**:
Affected Channels:
- [ ] CLI
- [ ] Node Module
- [ ] Extension
- [ ] DevTools

Lighthouse version:
Node.js version:
Operating System:
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it does change the URL but you also get this (at least, if I understand it right).

screen shot 2018-05-14 at 8 38 23 pm

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh that's awesome!! They should add that to the post 😆

Do we need the global one then if you always get this option?

Copy link
Collaborator

Choose a reason for hiding this comment

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

BTW where did that screenshot come from?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The SS came from webpack repo LINK.

Think the global one would be nice to have? Wouldn't hurt to keep it around.

Copy link
Collaborator

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

Ya let's nuke the global issue template. The specific ones are good 'nuff.

about: Suggest an idea to us!

---

<!-- Before creating an feature request please make sure you are using the latest version. -->

<!-- If this is a new audit please review the audit doc https://github.com/GoogleChrome/lighthouse/blob/master/docs/new-audits.md -->

## Feature request

**Summary of the feature request?**
<!-- Describe to us the need for this change -->
<!-- Are you willing to work on this yourself? -->


**What is the motivation or use case for changing this?**


**How is this beneficial to Ligthhouse?**

9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/Other.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Other
about: Throw something out there!

---

<!-- We would love to hear anything on your mind about Lighthouse -->
**Summary**

12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Thank you for submitting a pull request! -->

**Summary**
<!-- What kind of change does this PR introduce? -->
<!-- Is this a bugfix, feature, refactoring, build related change, etc? -->

<!-- Describe the need for this change -->

<!-- Link any documentation or information that would help understand this change -->

**Related Issues/PRs**
<!-- Provide any additional information we might need to understand the pull request -->