Skip to content

Commit

Permalink
add doc in branch prefix table
Browse files Browse the repository at this point in the history
  • Loading branch information
signekb committed Oct 25, 2023
1 parent b340fe9 commit 1b0da52
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions entries/git-workflow-guidelines/branching.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ When you create a branch, it's important to give the branch a short, descriptive
| Bugfix | For fixing a bug | bugfix/(short-description) | bugfix/fix-data-cleaning-error |
| Feature | For adding, removing, or modifying a feature* | feature/(short-description) | feature/add-variance-plot |
| Hotfix | For quickly fixing critical issues, usually with a temporary solution | hotfix/(short-description) | hotfix/fix-select-button |
| Doc | For writing, updating, or fixing documentation | doc/(short-description) | doc/git-guidelines |

In the table above, (short-description) in the "Pattern" column is a short phrase, concisely describing the work done on the branch. Examples of short descriptions could be *fix-data-cleaning-error*, *add-variance-plot*, *fix-recursive-loop*, or *init-git-entry*. As with file naming, we use the [kebab-case](https://www.tuple.nl/knowledge-base/kebab-case) naming convention. :warning: not written anywhere why we do it or that we do it. Should we add a decision post on this somewhere? :warning:

Expand Down

0 comments on commit 1b0da52

Please sign in to comment.