Skip to content

Commit e74d746

Browse files
markeriksonmarkerikson
authored
Doc issue templates (reduxjs#3620)
* Add issue/PR templates for docs stuff * Update bugfix templates * Remove pasted stuff from PR bugfix template * Formatting
1 parent b0e2430 commit e74d746

File tree

7 files changed

+153
-5
lines changed

7 files changed

+153
-5
lines changed

‎.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,32 @@ name: "\U0001F41BBug report"
33
about: Something is wrong with Redux.
44
---
55

6-
**Do you want to request a _feature_ or report a _bug_?**
6+
## Do you want to request a _feature_ or report a _bug_?
77

88
(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.)
99

10-
**What is the current behavior?**
10+
### Prior Issues
1111

12-
**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.**
12+
Are there any existing issues or PRs that relate to this problem? If so, link them here.
1313

14-
**What is the expected behavior?**
14+
## Bug Reports
1515

16-
**Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux?**
16+
### What is the current behavior?
17+
18+
### Steps to Reproduce
19+
20+
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.
21+
22+
### What is the expected behavior?
23+
24+
### Environment Details
25+
26+
Which versions of Redux, and which browser and OS are affected by this issue? Did this work in previous versions of Redux?
27+
28+
## New Features
29+
30+
### What is the new or updated feature that you are suggesting?
31+
32+
### Why should this feature be included?
33+
34+
### What docs changes are needed to explain this?

‎.github/ISSUE_TEMPLATE/documentation-edit.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: "\U0001F4DD Documentation Fix"
3+
about: Fixing a problem in an existing docs page
4+
---
5+
6+
## What docs page needs to be fixed?
7+
8+
- **Section**:
9+
- **Page**:
10+
11+
## What is the problem?
12+
13+
## What should be changed to fix the problem?

‎.github/ISSUE_TEMPLATE/documentation-new.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "\U0001F4D6 New/Updated Documentation Content"
3+
about: Adding a new docs page, or updating content in an existing docs page
4+
---
5+
6+
## What docs page is being added or updated?
7+
8+
- **Section**:
9+
- **Page**:
10+
11+
## For Adding New Content
12+
13+
### What kind of content category is this page (tutorial, how-to, explanation, reference)?
14+
15+
### Who is the intended target audience?
16+
17+
#### What knowledge are we assuming they have?
18+
19+
### What are the intended results or takeaways from reading this page?
20+
21+
### What is the most critical info they should learn?
22+
23+
## For Updating Existing Content
24+
25+
### What updates should be made to the page?
26+
27+
### Do these updates change any of the assumptions or target audience? If so, how do they change?

‎.github/ISSUE_TEMPLATE/Custom.md renamed to ‎.github/ISSUE_TEMPLATE/usage.md

File renamed without changes.

‎.github/PULL_REQUEST_TEMPLATE/bugfix.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: "\U0001F41B Bug fix or new feature"
3+
about: Fixing a problem with Redux
4+
---
5+
6+
## PR Type
7+
8+
### Does this PR add a new _feature_, or fix a _bug_?
9+
10+
### Why should this PR be included?
11+
12+
## Checklist
13+
14+
- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
15+
- [ ] Is there an existing issue for this PR?
16+
- _link issue here_
17+
- [ ] Have the files been linted and formatted?
18+
- [ ] Have the docs been updated to match the changes in the PR?
19+
- [ ] Have the tests been updated to match the changes in the PR?
20+
- [ ] Have you run the tests locally to confirm they pass?
21+
22+
## New Features
23+
24+
### What new capabilities does this PR add?
25+
26+
### What docs changes are needed to explain this?
27+
28+
## Bug Fixes
29+
30+
### What is the current behavior, and the steps to reproduce the issue?
31+
32+
### What is the expected behavior?
33+
34+
### How does this PR fix the problem?

‎.github/PULL_REQUEST_TEMPLATE/documentation-edit.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "\U0001F4DD Documentation Fix"
3+
about: Fixing a problem in an existing docs page
4+
---
5+
6+
## Checklist
7+
8+
- [ ] Is there an existing issue for this PR?
9+
- _link issue here_
10+
- [ ] Have the files been linted and formatted?
11+
12+
## What docs page needs to be fixed?
13+
14+
- **Section**:
15+
- **Page**:
16+
17+
## What is the problem?
18+
19+
## What changes does this PR make to fix the problem?

‎.github/PULL_REQUEST_TEMPLATE/documentation-new.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: "\U0001F4D6 New/Updated Documentation Content"
3+
about: Adding a new docs page, or updating content in an existing docs page
4+
---
5+
6+
## PR Type
7+
8+
**Does this PR add a _new_ page, or update an _existing_ page?**
9+
10+
## Checklist
11+
12+
- [ ] Is there an existing issue for this PR?
13+
- _link issue here_
14+
- [ ] Have the files been linted and formatted?
15+
16+
## What docs page is being added or updated?
17+
18+
- **Section**:
19+
- **Page**:
20+
21+
## For Adding New Content
22+
23+
### What kind of content category is this page (tutorial, how-to, explanation, reference)?
24+
25+
### Who is the intended target audience?
26+
27+
#### What knowledge are we assuming they have?
28+
29+
### What are the intended results or takeaways from reading this page?
30+
31+
### What is the most critical info they should learn?
32+
33+
## For Updating Existing Content
34+
35+
### What updates should be made to the page?
36+
37+
### Do these updates change any of the assumptions or target audience? If so, how do they change?

0 commit comments

Comments
 (0)