Skip to content

Commit 5e61f02

Browse files
committed
fix: move content to the right section
1 parent 49e0be7 commit 5e61f02

File tree

2 files changed

+14
-20
lines changed

2 files changed

+14
-20
lines changed

doc/source/how-to/contributing.rst

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -206,26 +206,6 @@ changes any given branch is introducing before looking at the code.
206206
- ``testing/`` or ``test/``: Improvements or changes to testing.
207207
- ``release/``: Releases (see below).
208208

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-
229209
Push your branch
230210
----------------
231211

doc/source/how-to/repository-protection.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,20 @@ The PyAnsys core team recommends setting these rules for the ``main`` branch:
7070
go through and resolve all comments. This ensures that all comments are read and
7171
possibly applied.
7272

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+
7387
Tag protection
7488
--------------
7589

0 commit comments

Comments
 (0)