Skip to content

Commit 73c85ca

Browse files
author
Amanda Butler
authored
Edit workflow.md
Edit file, mostly for consistent capitalization, consistent person and spelling.
1 parent 1832b61 commit 73c85ca

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,7 @@ If commits do not follow the above guidelines, we may request that you modify th
6363

6464
## Pull request template
6565

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:
6967

7068
### Description (*required*)
7169

@@ -107,14 +105,14 @@ explanation of the requirements.
107105

108106
### Description field
109107

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.
114112

115113
### Pull request type
116114

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.
118116

119117
#### Patch update
120118

0 commit comments

Comments
 (0)