Skip to content

Commit 22ed9e7

Browse files
authored
Merge pull request #312 from rxu/clarify-branch-naming
Adjust branches naming docs to make it a bit more clear.
2 parents 94ec2be + 938f0de commit 22ed9e7

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

development/development/git.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,20 @@ consider adding it as an idea to `phpBB Ideas <https://www.phpbb.com/community/i
6868

6969
Branch Names
7070
============
71-
Feature branches should be called **feature/feature-name**. Bug or minor
72-
improvements do not need a name, their branches should be called **ticket/1234**
73-
with the correct ticket id. If you want to give something a name that is not a
74-
feature you may use **task/task-name**. When these branches go into the main
75-
phpBB repository they are renamed **<category>/<user>/<name-or-id>** or
76-
**user/<category>/<name-or-id>** to make clear from which developer's repository
77-
the branch was merged.
71+
Branch names must have a prefix ending with a slash. There are only 3 types of prefixes allowed:
72+
73+
- ``feature/`` followed by a feature name for branches adding a feature.
74+
- ``task/`` followed by a task name for branches which neither adding a feature nor fixing bugs.
75+
- ``ticket/`` followed by a ticket number for branches fixing bugs.
76+
77+
Branch naming examples:
78+
79+
- ``feature/feature-name`` for features.
80+
- ``task/task-name`` for tasks.
81+
- ``ticket/12345`` for bugs fixes.
82+
83+
| When branches go into the main phpBB repository they are renamed to **<category>/<user>/<name-or-id>**
84+
| or **user/<category>/<name-or-id>** to make clear from which developer's repository the branch was merged.
7885
7986
Commit Messages
8087
===============

0 commit comments

Comments
 (0)