Skip to content

Commit 7c52507

Browse files
committed
workflow: pr template addition
1 parent 0fdf7ca commit 7c52507

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,30 @@ Pull requests on GitHub have to meet the following requirements to keep the code
5151
- Prefixing your commit message with a domain is acceptable, and we recommend doing so when it makes sense. However, prefixing one's domain with the name of the repo is not useful. For example, making a commit entitled "mbed-drivers: Fix doppelwidget frobulation" to the `mbed-drivers` repo is not acceptable because it is already understood that the commit applies to `mbed-drivers`. Renaming the commit to "doppelwidget: Fix frobulation" would be better, if we presume that "doppelwidget" is a meaningful domain for changes, because it communicates that the change applies to the doppelwidget area of `mbed-drivers`.
5252
- All new features and enhancements require documentation, tests and user guides for us to accept them. Please link each pull request to all relevant documentation and testing pull requests.
5353

54+
##### Pull request template
55+
56+
A good example how a pull request template should look like.
57+
58+
```
59+
Fix deep sleep locking bug
60+
61+
# Description
62+
63+
Fix problems which could leave deep sleep locked unintentionally, along with adding tests to verify this behavior is fixed.
64+
65+
Tested locally with two targets, all toolchains.
66+
67+
Test results can be seen [here](just an example).
68+
69+
# Pull request type
70+
71+
- [x] Fix
72+
- [ ] Refactor
73+
- [ ] New Target
74+
- [ ] Feature
75+
76+
```
77+
5478
#### Mbed OS maintainers
5579

5680
The maintainers are a small group of Mbed OS engineers who are responsible for the Mbed OS codebase. Their primary role is to progress contributions, both internal and external, from the initial pull request state through to released code. They:

0 commit comments

Comments
 (0)