Skip to content

Commit bc902c4

Browse files
nmay231omnidan
authored andcommitted
Updated issue and PR templates for doc changes
1 parent 1adcafe commit bc902c4

File tree

2 files changed

+31
-23
lines changed

2 files changed

+31
-23
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
11
<!-- Source: https://github.com/stevemao/github-issue-templates/tree/master/conversational -->
22

3-
**Note: for support questions, please ask questions on the gitter chat**. This repository's issues are reserved for feature requests and bug reports. Visit the gitter chat [here](https://gitter.im/omnidan/redux-undo).
3+
**Note: for support questions about the usage of the library, please ask questions on the gitter chat**. The issue tracker is reserved for feature requests, bug reports and similar issues. Visit the gitter chat [here](https://gitter.im/omnidan/redux-undo).
44

5-
* **I'm submitting a ...**
6-
- [ ] bug report
7-
- [ ] feature request
8-
- [ ] support request => Please do not submit support request here, see note at the top of this template.
5+
#### I'm submitting a ...
6+
- [ ] Bug report
7+
- [ ] Feature request
8+
- [ ] Docs update
9+
- [ ] Support request => Please do not submit support requests here, see note at the top of this template.
910

10-
* **What is the current behavior?**
1111

12+
<!-- If this is a doc change, uncomment the following line, describe what needs to change, and then remove the other sections -->
13+
<!-- #### What docs need to be added/updated? -->
1214

1315

14-
* **What is the expected/desired behavior?**
16+
#### What is the current behavior/state of the project?
1517

1618

1719

18-
* **If this is a feature request, what is the use case for changing the behavior?**
20+
#### What is the desired behavior?
1921

2022

2123

22-
* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via a gist or similar.**
24+
#### If this is a feature request, what is the use case for changing the behavior?
2325

2426

2527

26-
* **Please tell us about your environment:**
28+
#### If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via a gist or similar.
29+
30+
31+
32+
#### Please tell us about your environment:
2733

2834
- Library version: 1.0.0
2935
- Redux version: 4.0.0
3036
- Browser: [all | Chrome XX | Firefox XX | IE XX | Safari XX | Edge XX]
3137
- Language: [all | TypeScript X.X | ES6/7 | ES5]
3238

3339

34-
* **Other information**
40+
#### Other information
3541

3642
(e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
3743

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
<!-- Source: https://github.com/stevemao/github-issue-templates/tree/master/conversational -->
22

3-
* **Please check if the PR fulfills these requirements**
4-
- [ ] The commit message(s) are descriptive of the changes made
5-
- [ ] The PR contains changes that are focused and differs from other PRs
6-
- For bug fixes or features:
7-
- [ ] Tests for the changes have been added where needed
8-
- [ ] Docs have been added / updated
3+
#### Please check if the PR fulfills these requirements
4+
- Is this just a doc change? (yes/no)
95

6+
- If no, then check that:
7+
- [ ] The commit message(s) are descriptive of the changes made
8+
- [ ] The PR contains changes that are focused and differs from other PRs
9+
- [ ] Tests for the changes have been added where needed
10+
- [ ] Docs have been added / updated
1011

11-
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
1212

13+
#### What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
1314

14-
<!-- If this is a simple doc change, remove the following lines -->
1515

16+
<!-- If this is a simple doc change, describe the changes and then remove the following sections -->
1617

17-
* **What is the current behavior?** (You can also link to an open issue here)
1818

19+
#### What is the current behavior? (You can also link to an open issue here)
1920

2021

21-
* **What is the new behavior (if this is a feature change)?**
2222

23+
#### What is the new behavior?
2324

2425

25-
* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
2626

27+
#### Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
2728

2829

29-
* **Other information**:
30+
31+
#### Other information:
3032

3133

0 commit comments

Comments
 (0)