From 722ef5f3e1732f28453f44b94c1cc49782cf69cc Mon Sep 17 00:00:00 2001 From: Andrew n marshall Date: Thu, 26 Oct 2017 16:00:07 -0700 Subject: [PATCH] Updating the templates to minimize checkboxes and use HTML comments. (#1394) --- .github/ISSUE_TEMPLATE.md | 80 +++++++++++++++++++------------- .github/PULL_REQUEST_TEMPLATE.md | 50 +++++++++++--------- 2 files changed, 77 insertions(+), 53 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 888f9c3f2..f0bd0b762 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,57 +1,73 @@ -Thanks for opening an issue for us! Before you open an issue, please check if a similar issue exists or has been closed before. - -If you're asking a question about how to use Blockly in your application, please ask questions on the [mailing list](https://groups.google.com/forum/#!forum/blockly) instead of filing issues. - -_Please delete the above section and the instructions in the sections below before submitting. If a section is not applicable, type "N/A" in that section._ + ### Problem statement -_Remove this hint: these checkboxes can be checked like this: [x]_ - -- [ ] Bug report -- [ ] Feature request - -_What were you trying to do when you hit this bug? Or, what do you want to do with Blockly that your proposed feature would enable?_ + ### Expected Behavior -_Please describe what should happen. Include screenshots if applicable._ + ### Actual Behavior -_Describe what actually happens. Include screenshots if applicable._ + ### Steps to Reproduce -_Explain what someone needs to do in order to see what's described in *Actual behavior* above_ + + +1. Start by.. +2. Next, do.. ### Stack Traces -``` -Please open up the console. If you see any Blockly-related errors, paste them here. + -Ignore any instances of "Uncaught (in promise) DOMException: The play() request was interrupted by a call to pause()." +``` +Replace with error stack trace. ``` ### Operating System and Browser -_Remove this hint: these checkboxes can be checked like this: [x]_ + -- [ ] Desktop: - - [ ] Chrome - - [ ] Firefox - - [ ] Safari - - [ ] Opera - - [ ] IE 10+ - - [ ] IE 11 - - [ ] EDGE + + + + + + + -- [ ] Smartphone/Tablet/Chromebook (please complete the following information): - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + ### Additional Information -_Anything else we should know?_ + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e1082806b..c828f5842 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,12 @@ -Thanks for submitting code to Blockly! Please fill out the following as part of your pull request so we can review your code more easily. + ## The basics + + - [ ] I branched from develop - [ ] My pull request is against develop - [ ] My code follows the [style guide](https://developers.google.com/blockly/guides/modify/web/style-guide) @@ -9,37 +14,40 @@ Thanks for submitting code to Blockly! Please fill out the following as part of ## The details ### Resolves -_What Github issue does this resolve (please include link)?_ + ### Proposed Changes -_Describe what this Pull Request does. Include screenshots if applicable._ + ### Reason for Changes -_Explain why these changes should be made. Include screenshots if applicable._ + ### Test Coverage -_Please show how you have added tests to cover your changes, or tell us how you tested it and on which platforms._ + Tested on: -_Remove this hint: these checkboxes can be checked like this: [x]_ -- [ ] Desktop: - - [ ] Chrome - - [ ] Firefox - - [ ] Safari - - [ ] Opera - - [ ] IE 10+ - - [ ] IE 11 - - [ ] EDGE + + + + + + + + + -- [ ] Smartphone/Tablet/Chromebook (please complete the following information): - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - ### Additional Information -_Anything else we should know?_ +