Skip to content

Commit 0ee5d09

Browse files
author
Amanda Butler
authored
Copy edit workflow.md
Copy edit latest content.
1 parent 9bc8147 commit 0ee5d09

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ Pull requests on GitHub have to meet the following requirements to keep the code
6161
- Avoid merging commmits. (Always rebase when possible.)
6262
- Pull requests should fix a bug, add a feature or refactor.
6363

64-
#### Mbed OS release versioning
64+
#### Release versioning
6565

66-
Version number MAJOR.FEATURE.PATCH where:
66+
The Mbed OS version number follows the format MAJOR.FEATURE.PATCH. We use the:
6767

68-
- MAJOR version for incompatible API changes
69-
- FEATURE version for adding functionality in backward-compatible manner
70-
- PATCH version for backward-compatible bug fixes
68+
- MAJOR version for incompatible API changes.
69+
- FEATURE version for adding functionality in backward-compatible manner.
70+
- PATCH version for backward-compatible bug fixes.
7171

7272
### Pull request categories
7373

@@ -94,33 +94,33 @@ We consider the following pull request types.
9494

9595
##### Fix
9696

97-
A bug fix is backward-compatible internal change that fixes incorrect behavior.
97+
A bug fix is a backward-compatible internal change that fixes incorrect behavior.
9898

9999
Release: patch
100100

101101
##### Refactor
102102

103-
Refactors are intended for feature releases if they are not fixing specific issue as they can introduce new issues.
103+
Refactors are intended for feature releases if they are not fixing specific issues because they can introduce new issues.
104104

105105
Release: feature
106106

107107
##### New target
108108

109-
Adding a new target targets the patch release as it updating targets folder implementation.
109+
Adding a new target is a change for a patch release because it updates the targets folder implementation.
110110

111111
Release: patch
112112

113113
##### Feature
114114

115-
New features targets feature releases. It can be integrated only if the feature supports most of the targets (if it requires new target HAL implementation).
115+
New features target feature releases. A new feature can be integrated only if the feature supports most of the targets (if it requires new target HAL implementation).
116116

117-
Adding a new functionality is considered to be a feature. It does not matter if it is C++, C or Python.
117+
We consider adding a new functionality to be a feature. It does not matter if it is C++, C or Python.
118118

119119
Release: feature
120120

121121
##### Breaking change
122122

123-
Any change that results in breaking user space. It should have strong justification to be considered. Often the change could be made backward compatible, for example deprecate the old functionality and introduce the new replacement.
123+
A breaking change is any change that results in breaking user space. It should have strong justification for us to consider it. Often, such changes can be backward compatible, for example, deprecating the old functionality and introducing the new replacement.
124124

125125
Release: major
126126

0 commit comments

Comments
 (0)