Skip to content

Commit

Permalink
docs: 🎨 change pseudo code blocks including commit messages from bash…
Browse files Browse the repository at this point in the history
… to default

By changing these blocks to "default", all text in the code blocks is now the same colour. E.g., the opening paranthesis in commit messages including scope were shown in red in bash code blocks. By changing it to "default", the parenthesis is now the same colour as the rest of the text in the block.
  • Loading branch information
signekb committed Nov 27, 2023
1 parent c9d1e36 commit c5ac3d7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions entries/git-workflow-guidelines/commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ What constitutes a good commit message can differ according to different convent

According to the Conventional Commits convention, commit messages should be structured like so:

```bash
```default
<type>([optional scope]): <description>
[optional body]
Expand Down Expand Up @@ -97,13 +97,13 @@ To aid the understanding of all these parts of a conventional commit message, he

### Commit Message with Only Required Items (Prefix and Description)

```bash
```default
fix: reduce data point opacity for a clearer regression line in the scatter plot
```

### Commit Message with All Optional Items

```bash
```default
docs(decision-posts): update headers to fit template
The headers of these posts did not follow the new decision post template.
Expand All @@ -114,7 +114,7 @@ Issue: #31 (update decision posts to fit new template)

### Commit Message with Required Items + Scope and Body

```bash
```default
feat(t-test): add option to change significance level
For the second part of our analysis, we want to be able to change the
Expand Down Expand Up @@ -261,7 +261,7 @@ This command will show you the first chunk with changes with edited or deleted t

In Git, a changed part is called a *hunk* and you will have the following options for the shown hunk:

```bash
```default
y = Stage this hunk to commit next.
n = Don’t stage this hunk to commit next.
q = Quit. Don’t stage this or any other remaining hunks.
Expand Down Expand Up @@ -342,7 +342,7 @@ Go to the [Git Guides](https://github.com/git-guides/git-commit#how-to-undo-comm
- You should commit often based around isolated, complete changes (*atomic* commits)
- Following the *Conventional Commits* convention, a commit message should have this structure:

```bash
```default
<type>([optional scope]): <description>
[optional body]
Expand Down

0 comments on commit c5ac3d7

Please sign in to comment.