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
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -61,13 +61,13 @@ Pull requests on GitHub have to meet the following requirements to keep the code
61
61
- Avoid merging commmits. (Always rebase when possible.)
62
62
- Pull requests should fix a bug, add a feature or refactor.
63
63
64
-
#### Mbed OS release versioning
64
+
#### Release versioning
65
65
66
-
Version number MAJOR.FEATURE.PATCH where:
66
+
The Mbed OS version number follows the format MAJOR.FEATURE.PATCH. We use the:
67
67
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.
71
71
72
72
### Pull request categories
73
73
@@ -94,33 +94,33 @@ We consider the following pull request types.
94
94
95
95
##### Fix
96
96
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.
98
98
99
99
Release: patch
100
100
101
101
##### Refactor
102
102
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.
104
104
105
105
Release: feature
106
106
107
107
##### New target
108
108
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.
110
110
111
111
Release: patch
112
112
113
113
##### Feature
114
114
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).
116
116
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.
118
118
119
119
Release: feature
120
120
121
121
##### Breaking change
122
122
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.
0 commit comments