diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b23b8b0cf0..6a996defc8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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: '' --- @@ -34,15 +34,23 @@ 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`: + + **Please let us know what packages this bug is in regards to:** - [ ] `venia-concept` - [ ] `pwa-buildpack` @@ -50,9 +58,3 @@ If applicable, add screenshots to help explain your problem. - [ ] `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. diff --git a/.github/ISSUE_TEMPLATE/doc_change.md b/.github/ISSUE_TEMPLATE/doc_change.md new file mode 100644 index 0000000000..b4f409b128 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc_change.md @@ -0,0 +1,33 @@ +--- +name: Documentation Request +about: Help us improve the documentation +title: "[doc]: A short, simple sentence describing the doc request" +labels: documentation +assignees: 'jcalcaben' +--- + + + +**Describe the request** +A clear and concise description of the documentation request or where the documentation can be improved. + +**Possible solutions** +How would you word this addition or change? + +**Screenshots** +If applicable, add screenshots to help explain the problem. + + +**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) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 6312a7c2ed..8db92cf62c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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: '' - --- -**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 [...] @@ -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` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f88ba94504..855144e341 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,4 @@ - - ## Description @@ -25,41 +21,29 @@ Feel free to remove this section before creating this PR. Closes #ISSUE_NUMBER. -## Motivation and Context - - - ## Verification Steps +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? - ## Screenshots / Screen Captures (if appropriate): - ## Proposed Labels for Change Type/Package - - - - - - - + + + +- [ ] 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: -- [ ] 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.