You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/contributing/guidelines/workflow.md
+6-8Lines changed: 6 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -63,9 +63,7 @@ If commits do not follow the above guidelines, we may request that you modify th
63
63
64
64
## Pull request template
65
65
66
-
The following template is automatically provided on the raising of a pull request against mbed-os.
67
-
The details required will depend on the type of pull request being raised. See below for a more detailed
68
-
explanation of the requirements.
66
+
The following template is automatically provided when you raise a pull request against `mbed-os`. The details required depend on the type of pull request you create:
69
67
70
68
### Description (*required*)
71
69
@@ -107,14 +105,14 @@ explanation of the requirements.
107
105
108
106
### Description field
109
107
110
-
There are two parts to the description, both of which are required.
111
-
The first is a summary of the pull request. This should clearly state the reason for the PR and what
112
-
the changes entail. The second part requires the author to state what, if any, documentation changes
113
-
also need to be made to accompany the changes.
108
+
There are two parts to the description, both of which are required:
109
+
110
+
- The summary of the pull request clearly states the reason for the PR and what the changes involve.
111
+
- The documentation section requires you to state what, if any, documentation changes need to accompany the code changes.
114
112
115
113
### Pull request type
116
114
117
-
There are three pull request types and these correspond to the 3 main categories specified in semantic versionning, Patch, Feature (Minor) and Major.
115
+
There are three pull request types, and these correspond to the three main categories specified in semantic versioning: patch, feature (minor) and major.
0 commit comments