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.

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

[dev]: Minor changes to the templates. Also added a doc change issue template #1077

Merged
merged 6 commits into from
Mar 28, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
36 changes: 19 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
name: Bug Report
about: Report a bug you've found in our code!
title: "[bug]: A short, simple sentence describing the bug"
labels: bug
assignees: ''
---
Expand Down Expand Up @@ -34,25 +34,27 @@ A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.

**Please complete the following device information:**
- Device: [e.g. iPhone6, PC]
- OS: [e.g. iOS8.1, Windows 10]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
- Magento Version
- NPM version `npm -v`
- Node Version `node -v`
**Additional context**
Add any other context about the problem here.

**Possible solutions**
Add any ideas about possible solutions to the problem here.

**Please complete the following device information:**
- Device [e.g. iPhone6, PC, Mac, Pixel3]:
- OS [e.g. iOS8.1, Windows 10]:
- Browser [e.g. Chrome, Safari]:
- Browser Version [e.g. 22]:
- Magento Version:
- PWA Studio Version:
- NPM version `npm -v`:
- Node Version `node -v`:

<!-- Complete the following sections to help us apply appropriate labels! -->
**Please let us know what packages this bug is in regards to:**
- [ ] `venia-concept`
- [ ] `pwa-buildpack`
- [ ] `peregrine`
- [ ] `pwa-devdocs`
- [ ] `upward-js`
- [ ] `upward-spec`

**Additional context**
Add any other context about the problem here.

**Possible solutions**
Add any ideas about possible solutions to the problem here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Documentation Request
about: Tell us how our documentation could improve
sirugh marked this conversation as resolved.
Show resolved Hide resolved
title: "[doc]: A short, simple sentence describing the doc change"
sirugh marked this conversation as resolved.
Show resolved Hide resolved
labels: documentation
assignees: 'jcalcaben'
---

<!--
Thank you for taking the time to report this issue!
GitHub Issues should only be created for problems/topics related to this project's codebase.

Before submitting this issue, please make sure you are complying with our Code of Conduct:
https://github.com/magento-research/pwa-studio/blob/develop/.github/CODE_OF_CONDUCT.md

Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.

Feel free to remove this section before creating this issue.
-->

**Describe the change**
sirugh marked this conversation as resolved.
Show resolved Hide resolved
A clear and concise description of what change you desire.
sirugh marked this conversation as resolved.
Show resolved Hide resolved

**To Reproduce**
sirugh marked this conversation as resolved.
Show resolved Hide resolved
If this is an issue with documentation, provide us a link or steps to get to the
erroneous page. If this is a new topic request, disregard.

**Screenshots**
If applicable, add screenshots to help explain the problem.

sirugh marked this conversation as resolved.
Show resolved Hide resolved
**Additional context**
Add any other context about the problem here.

<!-- Complete the following sections to help us apply appropriate labels! -->
**Please let us know whether this is a new topic or a topic change request:**
- [ ] New Topic Request (ie. missing entire topic/section)
- [ ] Topic Change Request (ie. spelling, organization)
23 changes: 11 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
name: Feature Request
about: Suggest a new feature!
title: "[feature]: A short, simple sentence describing the feature"
labels: enhancement
assignees: ''

---

<!--
Expand All @@ -19,14 +18,6 @@ Issues that do not comply with our Code of Conduct or do not contain enough info
Feel free to remove this section before creating this issue.
-->

**Please let us know what packages this feature is in regards to:**
- [ ] `venia-concept`
- [ ] `pwa-buildpack`
- [ ] `peregrine`
- [ ] `pwa-devdocs`
- [ ] `upward-js`
- [ ] `upward-spec`

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Expand All @@ -38,3 +29,11 @@ A clear and concise description of any alternative solutions or features you've

**Additional context**
Add any other context or screenshots about the feature request here.

**Please let us know what packages this feature is in regards to:**
- [ ] `venia-concept`
- [ ] `pwa-buildpack`
- [ ] `peregrine`
- [ ] `pwa-devdocs`
- [ ] `upward-js`
- [ ] `upward-spec`
38 changes: 11 additions & 27 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
<!--
Thank you for your contribution!

Before submitting this pull request, please make sure you have read our Contribution Guidelines and your PR meets our contribution standards:
https://github.com/magento-research/pwa-studio/blob/master/.github/CONTRIBUTING.md

Expand All @@ -9,11 +7,9 @@ If your PR addresses an existing GitHub Issue, please refer to it in the title o

We may ask you for changes in your PR in order to meet the standards set in our Contribution Guidelines. PRs that do not comply with our guidelines may be closed at the maintainers' discretion.

Feel free to remove this section before creating this PR.
Feel free to remove this section before creating this PR. Thank you for your contribution!
-->

<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail here -->

Expand All @@ -25,41 +21,29 @@ Feel free to remove this section before creating this PR.
<!--- Using the above wording causes Github to automatically close the issue on merge. -->
Closes #ISSUE_NUMBER.

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->


## Verification Steps
<!-- Please describe in detail how a reviewer can verify your changes. -->
1. Go to the FOO page.
2. Verify the BAR shows up.
3. Make sure BAZ does a thing.


## How Has This Been Tested?
## How Have YOU Tested this?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->


## Screenshots / Screen Captures (if appropriate):


## Proposed Labels for Change Type/Package
<!--- What types of changes does your code introduce? Let us know if this is a -->
<!--- BUG, FEATURE, DOCUMENTATION, or TEST change. -->


<!--- What packages are modified by this code? Let us know if this applies to -->
<!--- peregrine, pwa-buildpack, upward-js, upward-spec, venia-concept or pwa-devdocs -->

<!--- What type of change level would you suggest for this PR? -->
<!--- Major, Minor, or Patch? -->
<!--- See https://magento-research.github.io/pwa-studio/technologies/versioning/ for help -->
- [ ] major (e.g x.0.0 - a breaking change)
- [ ] minor (e.g 0.x.0 - a backwards compatible addition)
- [ ] patch (e.g 0.0.x - a bug fix)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have linked an issue to this PR.
- [ ] I have indicated the change type and relevant package(s).
- [ ] I have proposed a change level by adding one of the `version: Major`, `version: Minor`, or `version: Patch` labels based on the defined [Public API](https://magento-research.github.io/pwa-studio/technologies/versioning/).
- [ ] I have updated the documentation accordingly, if necessary.
- [ ] I have added tests to cover my changes, if necessary.
- [ ] All new and existing tests passed.
- [ ] All CI checks are green (linting, build/deploy, etc).
- [ ] At least one core contributor has approved this PR.