Skip to content

Commit ba3b4cd

Browse files
authored
Merge pull request #32 from WordPress/docs/branch-naming-conventions
Include contributing docs about branch naming conventions
2 parents 840fb5c + 3140d94 commit ba3b4cd

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,20 @@ class AuthHandler
6565

6666
All code must be backward compatible with PHP 7.4, which is the minimum required PHP version for this project.
6767

68+
## Branch naming conventions
69+
70+
There are a few protected branch naming conventions:
71+
72+
* `trunk`: The main development branch.
73+
* `release/*`: A branch for a specific release, useful e.g. for applying a hotfix.
74+
* `feature/*`: A branch for a larger feature that takes multiple iterative PRs towards completion.
75+
76+
These special branches are protected and are configured more strictly in regards to GitHub workflow configuration.
77+
78+
Branches that you use for implementing a pull request or experimenting can use any naming convention you prefer, _except_ the above. Additionally, please do not use branch names that would easily cause confusion, such as other common main branch names like `main` or `develop`.
79+
80+
Ideally, the branch name is in some form or shape descriptive of what it is for.
81+
6882
## Guidelines
6983

7084
- As with all WordPress projects, we want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [Code of Conduct](https://make.wordpress.org/handbook/community-code-of-conduct/).

0 commit comments

Comments
 (0)