Skip to content

Commit 5d63e5a

Browse files
Merge pull request #106 from bridadan/add_github_templates
Add issue and PR github templates
2 parents 617d9f1 + 1a516a5 commit 5d63e5a

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

.github/issue_template.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!--
2+
3+
************************************** WARNING **************************************
4+
5+
The ciarcom bot parses this header automatically. Any deviation from the
6+
template may cause the bot to automatically correct this header or may result in a
7+
warning message, requesting updates.
8+
9+
Please ensure that nothing follows the "Issue request type" section, all
10+
issue details are within the Description section and no changes are made to the
11+
template format (as detailed below).
12+
13+
*************************************************************************************
14+
15+
-->
16+
17+
### Description
18+
19+
<!--
20+
**Required**
21+
Add detailed description of what you are reporting.
22+
Good example: https://os.mbed.com/docs/mbed-os/v5.11/contributing/workflow.html
23+
Things to consider sharing:
24+
- What target does this relate to?
25+
- What toolchain (name + version) are you using?
26+
- What tools (name + version - is it mbedgt, mbed-ls, etc) are you using?
27+
- What version of mbed-os-tools are you using (pip show mbed-os-tools)?
28+
- Steps to reproduce. (Did you publish code or a test case that exhibits the problem?)
29+
-->
30+
31+
32+
### Issue request type
33+
34+
<!--
35+
**Required**
36+
Please add only one X to one of the following types. Do not fill multiple types (split the issue otherwise.)
37+
Please note this is not a GitHub task list, indenting the boxes or changing the format to add a '.' or '*' in front
38+
of them would change the meaning incorrectly. The only changes to be made are to add a description text under the
39+
description heading and to add a 'x' to the correct box.
40+
-->
41+
[ ] Question
42+
[ ] Enhancement
43+
[ ] Bug

.github/pull_request_template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
### Description
2+
3+
<!--
4+
**Required**
5+
Add here detailed changes summary, testing results, dependencies
6+
Good example: https://os.mbed.com/docs/mbed-os/v5.11/contributing/workflow.html (Pull request template)
7+
-->
8+
9+
10+
### Pull request type
11+
12+
<!--
13+
**Required**
14+
Please add only one X to one of the following types. Do not fill multiple types (split the pull request otherwise).
15+
Please note this is not a GitHub task list, indenting the boxes or changing the format to add a '.' or '*' in front
16+
of them would change the meaning incorrectly. The only changes to be made are to add a description text under the
17+
description heading and to add a 'x' to the correct box.
18+
-->
19+
[ ] Fix
20+
[ ] Refactor
21+
[ ] Target update
22+
[ ] Functionality change
23+
[ ] Docs update
24+
[ ] Test update
25+
[ ] Breaking change
26+
27+
### Reviewers
28+
29+
<!--
30+
Optional
31+
Request additional reviewers with @username
32+
-->

0 commit comments

Comments
 (0)