Skip to content

Commit 18844a0

Browse files
committed
workflow: add PR types explanation
Every PR type should be clear to a user. It is a user responsibility to specify PR type and accept the versioning based on it. Fixes #429
1 parent c45ecf3 commit 18844a0

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,43 @@ Each feature has a tech lead. This person is responsible for:
7979
- Rebasing often to track master development.
8080
- Reviewing any addition to the feature branch (approval required by the feature tech lead or another assigned person).
8181

82+
##### Pull request types
83+
84+
We consider the following pull request types.
85+
86+
##### Fix
87+
88+
A bug fix should be backward-compatible internal change that fixes incorrect behavior. The fix should provide a description what and how it fixes the issue. The test should be included to catch this issue in the future and confirm the correct behavior.
89+
90+
Release: patch version
91+
92+
##### Refactor
93+
94+
Refactors are intended for minor versions if they are not fixing specific issue as they
95+
can introduce new issues.
96+
97+
Release: minor version
98+
99+
##### New target
100+
101+
Adding a new target targets the patch release as it updating targets folder implementation.
102+
103+
Release: patch version
104+
105+
##### Feature
106+
107+
New features targets minor releases. It can be integrated only if the feature supports most of the targets (if it requires new target HAL implementation).
108+
109+
Adding a new functionality is considered to be a feature. It does not matter if it is C++ or C.
110+
111+
Release: minor version
112+
113+
##### Breaking change
114+
115+
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.
116+
117+
Release: minor version
118+
82119
##### Pull request template
83120

84121
Below is a good example of a pull request:

0 commit comments

Comments
 (0)