Skip to content

Commit e6be2de

Browse files
committed
Add ISSUE and PR templates
1 parent 21dc137 commit e6be2de

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

ISSUE_TEMPLATE.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
### Before submitting an issue to I have first:
2+
3+
- [ ] read the [contribution guidelines](https://github.com/adiwg/mdEditor/blob/develop/CONTRIBUTING.md)
4+
- [ ] searched for similar already [existing issue](https://github.com/adiwg/mdEditor/issues)
5+
- [ ] read the documentation and [wiki](https://github.com/adiwg/mdEditor/wiki)
6+
7+
If you have performed all the above, continue describing the issue with template below.
8+
9+
Please:
10+
11+
- *be as explicit has you can*
12+
- *if reporting a bug*
13+
- *describe the problem and its symptoms*
14+
- *explain how to reproduce*
15+
- *attach whatever information that can help understanding the context (screen capture, log files)*
16+
- *do your best to use correct English (re-read yourself)*
17+
18+
## Issue
19+
**mdEditor Version** (find version under settings):
20+
21+
**mdEditor Web Address** (enter the URL):
22+
23+
### Issue Description:
24+
25+
*Provide a general description of the problem. If issue is a feature request, tell us why this feature is useful.*
26+
27+
### Steps to reproduce (Bug reports only):
28+
29+
1. _____
30+
2. _____
31+
3. _____
32+
33+
### Observed Results (Bug reports only):
34+
35+
*What happened? This could be a description, log output, etc.*
36+
37+
### Expected Results (Bug reports only):
38+
39+
*What did you expect to happen?*

PULL_REQUEST_TEMPLATE.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Guidelines
2+
3+
### Create issue first
4+
5+
Please do not create a Pull Request without creating an issue first.
6+
Any change needs to be discussed before proceeding.
7+
Failure to do so may result in the rejection of the pull request.
8+
9+
### Test plan
10+
11+
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
12+
13+
Make sure tests pass on both Travis CI.
14+
15+
### Code formatting
16+
17+
See the CONTRIBUTING.md
18+
19+
### Closing issues
20+
21+
Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
22+
23+
## Pull Request
24+
25+
* **Please check if the PR fulfills these requirements**
26+
- [ ] The commit message follows our guidelines
27+
- [ ] Tests for the changes have been added (for bug fixes / features)
28+
- [ ] Docs have been added / updated (for bug fixes / features)
29+
30+
31+
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
32+
33+
34+
35+
* **What is the current behavior?** (You can also link to an open issue here)
36+
37+
38+
39+
* **What is the new behavior (if this is a feature change)?**
40+
41+
42+
43+
* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
44+
45+
46+
47+
* **Other information**:

0 commit comments

Comments
 (0)