Skip to content

Commit

Permalink
docs: Describe Git branch naming convention
Browse files Browse the repository at this point in the history
For:
#69
  • Loading branch information
liammulh committed Jul 8, 2024
1 parent 884de9d commit 2d4a36b
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions doc/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,25 @@ A commit should almost always be linked to a GitHub issue.
For:
https://github.com/org/repo/issues/123
```

## Name a Git branch

Here is the format we like to follow for branch names:

```
[initials]-[issue number]-[optional description]
```

For example, if your name is Ada Lovelace and the issue you're working on is
#123 your branch name would be:

```
al-123
```

If you wanted to add an optional (short) description at the end, you could name
it:

```
al-123-fix-foobar
```

0 comments on commit 2d4a36b

Please sign in to comment.