File tree Expand file tree Collapse file tree 2 files changed +14
-20
lines changed Expand file tree Collapse file tree 2 files changed +14
-20
lines changed Original file line number Diff line number Diff line change @@ -206,26 +206,6 @@ changes any given branch is introducing before looking at the code.
206
206
- ``testing/ `` or ``test/ ``: Improvements or changes to testing.
207
207
- ``release/ ``: Releases (see below).
208
208
209
- Enforcing branch-name conventions
210
- ---------------------------------
211
-
212
- `GitHub rulesets
213
- <https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets> `_
214
- allow to enforce branch-name conventions. To do so, create a new ruleset named
215
- ``conventional-commits ``, then select the following configuration:
216
-
217
- - Enforcement status: ``Active ``
218
- - Target branches:
219
- - Include: ``All branches ``
220
- - Exclude: ``main ``, ``gh-pages ``
221
-
222
- - Restrict branch names:
223
- - Applies to: ``Branch name ``
224
- - Requirement: ``Must match a given regex pattern ``
225
- - Matching pattern: ``^(feat|fix|chore|docs|style|refactor|test|perf|ci|build|dependabot|release)\/.* ``
226
- - Description: ``Branch name must match the conventional commits pattern ``
227
-
228
-
229
209
Push your branch
230
210
----------------
231
211
Original file line number Diff line number Diff line change @@ -70,6 +70,20 @@ The PyAnsys core team recommends setting these rules for the ``main`` branch:
70
70
go through and resolve all comments. This ensures that all comments are read and
71
71
possibly applied.
72
72
73
+ For other branches, conventional commits can be enforced by creating a rule
74
+ with the following parameters:
75
+
76
+ - Enforcement status: ``Active ``
77
+ - Target branches:
78
+ - Include: ``All branches ``
79
+ - Exclude: ``main ``, ``gh-pages ``
80
+
81
+ - Restrict branch names:
82
+ - Applies to: ``Branch name ``
83
+ - Requirement: ``Must match a given regex pattern ``
84
+ - Matching pattern: ``^(feat|fix|chore|docs|style|refactor|test|perf|ci|build|dependabot|release)\/.* ``
85
+ - Description: ``Branch name must match the conventional commits pattern ``
86
+
73
87
Tag protection
74
88
--------------
75
89
You can’t perform that action at this time.
0 commit comments