Skip to content

Commit 03559e0

Browse files
author
Amanda Butler
authored
Merge pull request #475 from 0xc0170/dev_pr_types
workflow: add PR types explanation
2 parents 755e515 + a6ba0af commit 03559e0

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ 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+
#### Release versioning
65+
66+
You can find Mbed OS versioning at [How We Release Arm Mbed OS](/docs/development/introduction/how-we-release-arm-mbed-os.html).
67+
6468
### Pull request categories
6569

6670
#### Bug fixes
@@ -80,7 +84,43 @@ Each feature has a tech lead. This person is responsible for:
8084
- Rebasing often to track master development.
8185
- Reviewing any addition to the feature branch (approval required by the feature tech lead or another assigned person).
8286

83-
#### Pull request template
87+
##### Pull request types
88+
89+
We consider the following pull request types.
90+
91+
##### Fix
92+
93+
A bug fix is a backward-compatible internal change that fixes incorrect behavior.
94+
95+
Release: patch
96+
97+
##### Refactor
98+
99+
Refactors are intended for feature releases if they are not fixing specific issues because they can introduce new issues.
100+
101+
Release: feature
102+
103+
##### New target
104+
105+
Adding a new target is a change for a patch release because it updates the targets folder implementation.
106+
107+
Release: patch
108+
109+
##### Feature
110+
111+
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).
112+
113+
We consider adding a new functionality to be a feature. It does not matter if it is C++, C or Python.
114+
115+
Release: feature
116+
117+
##### Breaking change
118+
119+
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.
120+
121+
Release: major
122+
123+
##### Pull request template
84124

85125
Below is a good example of a pull request:
86126

0 commit comments

Comments
 (0)