Skip to content

Commit f09b033

Browse files
author
Amanda Butler
authored
Merge pull request #746 from 0xc0170/dev_update_pr_types
Add "Docs update" to workflow
2 parents 6684a71 + 47eb822 commit f09b033

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

docs/reference/contributing/guidelines/workflow.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ Refactors are intended for feature releases, if they are not fixing specific iss
105105

106106
Release: feature
107107

108-
#### New target
108+
#### Target update
109109

110-
Adding a new target is a change for a patch release because it updates the targets folder implementation.
110+
Updating target implementation (adding a new target or updating already supported target) is a change for a patch release.
111111

112112
Release: patch
113113

@@ -119,6 +119,18 @@ We consider adding a new functionality to be a feature. It does not matter if it
119119

120120
Release: feature
121121

122+
#### Documentation update
123+
124+
Documentation updates include changes to markdown files or Doxygen documentation (comment-only changes).
125+
126+
Release: patch
127+
128+
#### Test update
129+
130+
Test updates include updates to a new test unit or test case.
131+
132+
Release: patch
133+
122134
#### Breaking change
123135

124136
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.
@@ -142,10 +154,13 @@ You can see test results [here](just an example).
142154
143155
# Pull request type
144156
145-
[x] Fix
146-
[ ] Refactor
147-
[ ] New Target
148-
[ ] Feature
157+
[X] Fix
158+
[ ] Refactor
159+
[ ] Target update
160+
[ ] Functionality change
161+
[ ] Docs update
162+
[ ] Test update
163+
[ ] Breaking change
149164
150165
```
151166

0 commit comments

Comments
 (0)