From f33cc47bba97cb3e01d9bb1a7fb66464d1575000 Mon Sep 17 00:00:00 2001 From: Mark Erikson Date: Sat, 16 Nov 2019 14:10:47 -0500 Subject: [PATCH 1/4] Add issue/PR templates for docs stuff --- .github/ISSUE_TEMPLATE/documentation-edit.md | 15 ++++++ .github/ISSUE_TEMPLATE/documentation-new.md | 37 +++++++++++++ .../ISSUE_TEMPLATE/{Custom.md => usage.md} | 0 .github/PULL_REQUEST_TEMPLATE/bugfix.md | 16 ++++++ .../documentation-edit.md | 23 ++++++++ .../documentation-new.md | 53 +++++++++++++++++++ 6 files changed, 144 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation-edit.md create mode 100644 .github/ISSUE_TEMPLATE/documentation-new.md rename .github/ISSUE_TEMPLATE/{Custom.md => usage.md} (100%) create mode 100644 .github/PULL_REQUEST_TEMPLATE/bugfix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation-edit.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation-new.md diff --git a/.github/ISSUE_TEMPLATE/documentation-edit.md b/.github/ISSUE_TEMPLATE/documentation-edit.md new file mode 100644 index 0000000000..15e2bea077 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-edit.md @@ -0,0 +1,15 @@ +--- +name: "\U0001F4DD Documentation Fix" +about: Fixing a problem in an existing docs page +--- + +## What docs page needs to be fixed? + +- **Section**: +- **Page**: + +## What is the problem? + + + +## What should be changed to fix the problem? \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation-new.md b/.github/ISSUE_TEMPLATE/documentation-new.md new file mode 100644 index 0000000000..175fb02166 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-new.md @@ -0,0 +1,37 @@ +--- +name: "\U0001F4D6 New/Updated Documentation Content" +about: Adding a new docs page, or updating content in an existing docs page +--- + +## What docs page is being added or updated? + +- **Section**: +- **Page**: + +## For Adding New Content + +### What kind of content category is this page (tutorial, how-to, explanation, reference)? + + +### Who is the intended target audience? + + +#### What knowledge are we assuming they have? + + +### What are the intended results or takeaways from reading this page? + + +### What is the most critical info they should learn? + + + + +## For Updating Existing Content + + +### What updates should be made to the page? + + + +### Do these updates change any of the assumptions or target audience? If so, how do they change? \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/usage.md similarity index 100% rename from .github/ISSUE_TEMPLATE/Custom.md rename to .github/ISSUE_TEMPLATE/usage.md diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md new file mode 100644 index 0000000000..fc9bd21dd2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -0,0 +1,16 @@ +--- +name: "\U0001F41B Bug report" +about: Fixing a problem with Redux +--- + +**Do you want to request a _feature_ or report a _bug_?** + +(If this is a _usage question_, please **do not post it here**—post it on [Stack Overflow](http://stackoverflow.com/questions/tagged/redux) instead. If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.) + +**What is the current behavior?** + +**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar.** + +**What is the expected behavior?** + +**Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux?** diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation-edit.md b/.github/PULL_REQUEST_TEMPLATE/documentation-edit.md new file mode 100644 index 0000000000..2fbd440850 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/documentation-edit.md @@ -0,0 +1,23 @@ +--- +name: "\U0001F4DD Documentation Fix" +about: Fixing a problem in an existing docs page +--- + +## Checklist + +- [ ] Is there an existing issue for this PR? + - *link issue here* +- [ ] Have the files been linted and formatted? + + +## What docs page needs to be fixed? + +- **Section**: +- **Page**: + + +## What is the problem? + + + +## What changes does this PR make to fix the problem? \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation-new.md b/.github/PULL_REQUEST_TEMPLATE/documentation-new.md new file mode 100644 index 0000000000..e366ba7e0a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/documentation-new.md @@ -0,0 +1,53 @@ +--- +name: "\U0001F4D6 New/Updated Documentation Content" +about: Adding a new docs page, or updating content in an existing docs page +--- + +## PR Type + +**Does this PR add a _new_ page, or update an _existing_ page?** + + + +## Checklist + +- [ ] Is there an existing issue for this PR? + - *link issue here* +- [ ] Have the files been linted and formatted? + + +## What docs page is being added or updated? + +- **Section**: +- **Page**: + + + +## For Adding New Content + +### What kind of content category is this page (tutorial, how-to, explanation, reference)? + + +### Who is the intended target audience? + + +#### What knowledge are we assuming they have? + + +### What are the intended results or takeaways from reading this page? + + +### What is the most critical info they should learn? + + + + +## For Updating Existing Content + + + +### What updates should be made to the page? + + + +### Do these updates change any of the assumptions or target audience? If so, how do they change? \ No newline at end of file From b570fb1ce0a16a117880b21e0cba41ad2712e81f Mon Sep 17 00:00:00 2001 From: Mark Erikson Date: Sat, 16 Nov 2019 14:27:43 -0500 Subject: [PATCH 2/4] Update bugfix templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 46 ++++++++++++++++++++++--- .github/PULL_REQUEST_TEMPLATE/bugfix.md | 45 ++++++++++++++++++++++-- 2 files changed, 83 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index a32167a58a..2b5f5f5c0b 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -3,14 +3,50 @@ name: "\U0001F41BBug report" about: Something is wrong with Redux. --- -**Do you want to request a _feature_ or report a _bug_?** + +## Do you want to request a _feature_ or report a _bug_? (If this is a _usage question_, please **do not post it here**—post it on [Stack Overflow](http://stackoverflow.com/questions/tagged/redux) instead. If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.) -**What is the current behavior?** -**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar.** -**What is the expected behavior?** +### Prior Issues + +Are there any existing issues or PRs that relate to this problem? If so, link them here. + + + + +## Bug Reports + +### What is the current behavior? + + + +### Steps to Reproduce + +If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://codesandbox.io or similar. + + +### What is the expected behavior? + + + +### Environment Details + +Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux? + + + +## New Features + +### What is the new or updated feature that you are suggesting? + + + + +### Why should this feature be included? + + -**Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux?** +### What docs changes are needed to explain this? diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md index fc9bd21dd2..d399997fa8 100644 --- a/.github/PULL_REQUEST_TEMPLATE/bugfix.md +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -1,11 +1,50 @@ --- -name: "\U0001F41B Bug report" +name: "\U0001F41B Bug fix or new feature" about: Fixing a problem with Redux --- -**Do you want to request a _feature_ or report a _bug_?** -(If this is a _usage question_, please **do not post it here**—post it on [Stack Overflow](http://stackoverflow.com/questions/tagged/redux) instead. If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.) +## PR Type + +### Does this PR add a new _feature_, or fix a _bug_? + + + +### Why should this PR be included? + + + + +## Checklist + +- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? +- [ ] Is there an existing issue for this PR? + - *link issue here* +- [ ] Have the files been linted and formatted? +- [ ] Have the docs been updated to match the changes in the PR? +- [ ] Have the tests been updated to match the changes in the PR? +- [ ] Have you run the tests locally to confirm they pass? + + +## New Features + +### What new capabilities does this PR add? + + +### What docs changes are needed to explain this? + + + +## Bug Fixes + +### What is the current behavior, and the steps to reproduce the issue? + + +### What is the expected behavior? + + + +### How does this PR fix the problem? **What is the current behavior?** From 70971251f91851566026cdbb8608e802954410b4 Mon Sep 17 00:00:00 2001 From: Mark Erikson Date: Sat, 16 Nov 2019 14:29:28 -0500 Subject: [PATCH 3/4] Remove pasted stuff from PR bugfix template --- .github/PULL_REQUEST_TEMPLATE/bugfix.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md index d399997fa8..81e3fe42e6 100644 --- a/.github/PULL_REQUEST_TEMPLATE/bugfix.md +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -46,10 +46,3 @@ about: Fixing a problem with Redux ### How does this PR fix the problem? -**What is the current behavior?** - -**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar.** - -**What is the expected behavior?** - -**Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux?** From 0f9989bd940b38c3c7d5901897139ae4e9bac137 Mon Sep 17 00:00:00 2001 From: Mark Erikson Date: Sat, 16 Nov 2019 14:30:43 -0500 Subject: [PATCH 4/4] Formatting --- .github/ISSUE_TEMPLATE/Bug_report.md | 20 +--------------- .github/ISSUE_TEMPLATE/documentation-edit.md | 8 +++---- .github/ISSUE_TEMPLATE/documentation-new.md | 16 +++---------- .github/PULL_REQUEST_TEMPLATE/bugfix.md | 16 +------------ .../documentation-edit.md | 12 ++++------ .../documentation-new.md | 24 ++++--------------- 6 files changed, 16 insertions(+), 80 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 2b5f5f5c0b..a660d1906c 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -3,50 +3,32 @@ name: "\U0001F41BBug report" about: Something is wrong with Redux. --- - ## Do you want to request a _feature_ or report a _bug_? (If this is a _usage question_, please **do not post it here**—post it on [Stack Overflow](http://stackoverflow.com/questions/tagged/redux) instead. If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.) - - ### Prior Issues -Are there any existing issues or PRs that relate to this problem? If so, link them here. - - - +Are there any existing issues or PRs that relate to this problem? If so, link them here. ## Bug Reports ### What is the current behavior? - - ### Steps to Reproduce If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://codesandbox.io or similar. - ### What is the expected behavior? - - ### Environment Details Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux? - - ## New Features ### What is the new or updated feature that you are suggesting? - - - ### Why should this feature be included? - - ### What docs changes are needed to explain this? diff --git a/.github/ISSUE_TEMPLATE/documentation-edit.md b/.github/ISSUE_TEMPLATE/documentation-edit.md index 15e2bea077..a091b43ae2 100644 --- a/.github/ISSUE_TEMPLATE/documentation-edit.md +++ b/.github/ISSUE_TEMPLATE/documentation-edit.md @@ -5,11 +5,9 @@ about: Fixing a problem in an existing docs page ## What docs page needs to be fixed? -- **Section**: -- **Page**: +- **Section**: +- **Page**: ## What is the problem? - - -## What should be changed to fix the problem? \ No newline at end of file +## What should be changed to fix the problem? diff --git a/.github/ISSUE_TEMPLATE/documentation-new.md b/.github/ISSUE_TEMPLATE/documentation-new.md index 175fb02166..07c357190e 100644 --- a/.github/ISSUE_TEMPLATE/documentation-new.md +++ b/.github/ISSUE_TEMPLATE/documentation-new.md @@ -5,33 +5,23 @@ about: Adding a new docs page, or updating content in an existing docs page ## What docs page is being added or updated? -- **Section**: -- **Page**: +- **Section**: +- **Page**: ## For Adding New Content ### What kind of content category is this page (tutorial, how-to, explanation, reference)? - ### Who is the intended target audience? - #### What knowledge are we assuming they have? - ### What are the intended results or takeaways from reading this page? - ### What is the most critical info they should learn? - - - ## For Updating Existing Content - ### What updates should be made to the page? - - -### Do these updates change any of the assumptions or target audience? If so, how do they change? \ No newline at end of file +### Do these updates change any of the assumptions or target audience? If so, how do they change? diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md index 81e3fe42e6..28769fe031 100644 --- a/.github/PULL_REQUEST_TEMPLATE/bugfix.md +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix.md @@ -3,46 +3,32 @@ name: "\U0001F41B Bug fix or new feature" about: Fixing a problem with Redux --- - ## PR Type ### Does this PR add a new _feature_, or fix a _bug_? - - ### Why should this PR be included? - - - ## Checklist - [ ] Have you added an explanation of what your changes do and why you'd like us to include them? - [ ] Is there an existing issue for this PR? - - *link issue here* + - _link issue here_ - [ ] Have the files been linted and formatted? - [ ] Have the docs been updated to match the changes in the PR? - [ ] Have the tests been updated to match the changes in the PR? - [ ] Have you run the tests locally to confirm they pass? - ## New Features ### What new capabilities does this PR add? - ### What docs changes are needed to explain this? - - ## Bug Fixes ### What is the current behavior, and the steps to reproduce the issue? - ### What is the expected behavior? - - ### How does this PR fix the problem? - diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation-edit.md b/.github/PULL_REQUEST_TEMPLATE/documentation-edit.md index 2fbd440850..fd29726699 100644 --- a/.github/PULL_REQUEST_TEMPLATE/documentation-edit.md +++ b/.github/PULL_REQUEST_TEMPLATE/documentation-edit.md @@ -6,18 +6,14 @@ about: Fixing a problem in an existing docs page ## Checklist - [ ] Is there an existing issue for this PR? - - *link issue here* + - _link issue here_ - [ ] Have the files been linted and formatted? - ## What docs page needs to be fixed? -- **Section**: -- **Page**: - +- **Section**: +- **Page**: ## What is the problem? - - -## What changes does this PR make to fix the problem? \ No newline at end of file +## What changes does this PR make to fix the problem? diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation-new.md b/.github/PULL_REQUEST_TEMPLATE/documentation-new.md index e366ba7e0a..fd574c9dfd 100644 --- a/.github/PULL_REQUEST_TEMPLATE/documentation-new.md +++ b/.github/PULL_REQUEST_TEMPLATE/documentation-new.md @@ -7,47 +7,31 @@ about: Adding a new docs page, or updating content in an existing docs page **Does this PR add a _new_ page, or update an _existing_ page?** - - ## Checklist - [ ] Is there an existing issue for this PR? - - *link issue here* + - _link issue here_ - [ ] Have the files been linted and formatted? - ## What docs page is being added or updated? -- **Section**: -- **Page**: - - +- **Section**: +- **Page**: ## For Adding New Content ### What kind of content category is this page (tutorial, how-to, explanation, reference)? - ### Who is the intended target audience? - #### What knowledge are we assuming they have? - ### What are the intended results or takeaways from reading this page? - ### What is the most critical info they should learn? - - - ## For Updating Existing Content - - ### What updates should be made to the page? - - -### Do these updates change any of the assumptions or target audience? If so, how do they change? \ No newline at end of file +### Do these updates change any of the assumptions or target audience? If so, how do they change?