Skip to content

Commit

Permalink
Merge pull request #76 from Builditluc/documentation/change-branch-na…
Browse files Browse the repository at this point in the history
…ming

This changes the branch naming for code changes in the contributing documentation.

Changes to the branch naming:
* Feature branches: feature/add-...
* Bug fix branches: bug/fix-...
* Documentation branches: documentation/add-...
  • Loading branch information
Builditluc authored Aug 11, 2022
2 parents b394ea7 + 2700e77 commit 13ef375
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions docs/contributing/develop-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,32 @@ Now that you've forked and cloned the repository you can create a branch for you

=== "Feature"

```shell
$ git checkout -b feature/add-{YOUR-FEATURE}
```
$ git checkout -b add-feature
```

You can also use `add-{FEATURE-NAME}` for the branch name or something entirely different. It's up to you but it would be nice if the branch has a descriptive name of what it changes

`{YOUR-FEATURE}` should be the name of the feature you want to add. For example if you add new title configuration options, it would be `add-title-configuration`

Instead of `add-...` you can also use `change-...` or something entirely different. It should, however, be a lowercase verb in the present tense that describes the type of change you're making

=== "Bug Fix"

```shell
$ git checkout -b bug/fix-{BUG-NAME]
```
$ git checkout -b fix-bug

`{BUG-NAME}` should be the name of the bug you want to fix. For example `crash-when-article-empty`

=== "Documentation Change"

```shell
$ git checkout -b documentation/add-{YOUR-CHANGE}
```

You can also use `fix-{BUG-NAME}` for the branch name or something entirely different. It's up to you but it would be nice if the branch has a descriptive name of what it changes
`{YOUR-CHANGE}` should be the name of the change. For example if you add new title configuration documentation, it would be `add-title-configuration`

Instead of `add-...` you can also use `change-...` or something entirely different. It should, however, be a lowercase verb in the present tense that describes the type of change you're making


<center>
Now you are ready to make your changes!
Expand Down

0 comments on commit 13ef375

Please sign in to comment.