Skip to content

Commit

Permalink
docs(contributing): what a shambles
Browse files Browse the repository at this point in the history
  • Loading branch information
ooliver1 committed Oct 29, 2022
1 parent 4a24447 commit c4be211
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,39 +57,39 @@ Mafic follows the [Conventional Commits](https://www.conventionalcommits.org/en/

Your commit messages should be in the present (imperative, 2nd person) tense, such as `Add`, not `Added`.

More specifically, we use the [Angular Types List](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) for commit types. This means that your commit messages should be formatted like this:

```text
<type>([scope]): <subject>
[BLANK LINE]
[body]
[BLANK LINE]
[footer]
```

> **Note**
> The type and subject are mandatory.
Examples include:

```txt
```text
feat: add support for some feature
```

```txt
```text
refactor(track)!: use a different method to get track info
This is a breaking change because the method used to get track info has changed.
```

```txt
```text
fix(node): use a different method to connect to the node
This fixes an issue where the node would not connect if the host was an IPV6 address.
Co-Authored-By: Some Person <email@example.com>
```

More specifically, we use the [Angular Types List](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) for commit types. This means that your commit messages should be formatted like this:

```txt
<type>([scope]): <subject>
[BLANK LINE]
[body]
[BLANK LINE]
[footer]
```

> **Note**
> The type and subject are mandatory.
### Type

`<type>` is one of the following:
Expand Down

0 comments on commit c4be211

Please sign in to comment.