Skip to content

Commit a7bc1d2

Browse files
authored
docs(contributors): update default branch info (#21)
1 parent 053836f commit a7bc1d2

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/guides/guide-contributor/general-guidelines.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -61,24 +61,25 @@ visualizes this process.
6161

6262
[![GitHub Flow](../../images/github_flow.svg)][github-flow]
6363

64-
1. [Create a "feature branch"][git-branch] from the `dev` branch; use the
64+
1. [Create a "feature branch"][git-branch] from the default branch; use the
6565
`feature/my-feature` naming pattern to name your feature branch, e.g.,
66-
`feature/update-docs`; make sure the `dev` [branch
66+
`feature/update-docs`; make sure the default [branch
6767
is up to date][git-pull] before creating the feature branch!
6868
2. [Commit code changes][git-commit] to address the issue you are working on
6969
3. [Push the feature branch][git-push] to the remote and [create a pull
7070
request][github-pr] in GitHub
7171
4. Address any comments added during code review by pushing additional commits
7272
(there may be multiple rounds of reviews)
7373
5. Once all issues are resolved, code owners will merge the feature branch into
74-
the `dev` branch using the ["squash merging"][github-merge-squash] method
74+
the default branch using the ["squash merging"][github-merge-squash] method
7575

7676
!!! note "Default branch"
7777

78-
`dev` is the default branch for all projects in pre-release state, i.e.,
79-
those with version numbers below `v1.0.0`. Upon release, `main` becomes
80-
the default branch, and [semantic versioning][sem-ver] is strictly adhered
81-
by.
78+
Typically, `dev` is the default branch for all projects in pre-release
79+
state, i.e., those with version numbers below `v1.0.0`. Upon release,
80+
`main` becomes the default branch, and [semantic versioning][sem-ver] is
81+
strictly adhered by. In some cases, there may not be a `dev` branch and
82+
`main` is used as the default branch straight away.
8283

8384
??? note "Substantial changes"
8485

0 commit comments

Comments
 (0)