Skip to content

Commit 56bb3f9

Browse files
authored
Merge pull request #264 from jupe/github_templates
initial issue and PR github templates
2 parents 3f4bebc + 3e3c10f commit 56bb3f9

File tree

2 files changed

+78
-0
lines changed

2 files changed

+78
-0
lines changed

.github/issue_template.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Note: This is just a template, so feel free to use/remove the unnecessary things
2+
3+
### Description
4+
- Type: Bug | Enhancement | Question
5+
- Related Issue: `#abc`
6+
- Priority: Blocker | Major | Minor
7+
8+
---------------------------------------------------------------
9+
## Bug
10+
11+
**mbed-os sha**
12+
(`git describe --tags`)
13+
14+
**mbed-cli version**
15+
(`mbed`)
16+
17+
**Expected Behavior**
18+
19+
**Actual Behavior**
20+
21+
**Steps to Reproduce**
22+
23+
----------------------------------------------------------------
24+
## Enhancement
25+
26+
**Reason to enhance/problem with existing solution**
27+
28+
**Suggested enhancement**
29+
30+
**Pros**
31+
32+
**Cons**
33+
34+
-----------------------------------------------------------------
35+
36+
## Question
37+
38+
**How to?**

.github/pull_request_template.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Notes:
2+
* Pull requests will not be accepted until the submitter has agreed to the contributer agreement.
3+
* This is just a template, so feel free to use/remove the unnecessary things
4+
5+
6+
## Status
7+
**READY/IN DEVELOPMENT/HOLD**
8+
9+
10+
## Migrations
11+
If this PR changes any APIs or behaviors, give a short description of what "API users" should do when this PR is merged.
12+
13+
YES | NO
14+
15+
16+
## Description
17+
A few sentences describing the overall goals of the pull request's commits.
18+
19+
20+
## Related PRs
21+
List related PRs against other branches:
22+
23+
branch | PR
24+
------ | ------
25+
other_pr_production | [link]()
26+
other_pr_master | [link]()
27+
28+
29+
## Todos
30+
- [ ] Tests
31+
- [ ] Documentation
32+
33+
34+
## Deploy Notes
35+
Notes regarding the deployment of the contained body of work. These should note any
36+
required changes in the build environment, tools, compilers, etc.
37+
38+
39+
## Steps to Test or Reproduce
40+
Outline the steps to test or reproduce the PR here.

0 commit comments

Comments
 (0)