Skip to content

Commit

Permalink
docs(CONTRIBUTING): updated with codespell information
Browse files Browse the repository at this point in the history
  • Loading branch information
AlejandroSuero committed May 15, 2024
1 parent 73f8668 commit 16b24ab
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ cargo install stylua
luarocks --lua-version=5.1 install vusted
```

> [!warning]
>
> In **CI** we will be using [codespell](https://github.com/codespell-project/codespell)
> to check that all is correctly spelled, you can use `make spell` to check it
> locally and `make spell-write` to perform fixable changes automatically.
## How to contribute

1. **Configure the development**
Expand Down Expand Up @@ -51,6 +57,10 @@ luarocks --lua-version=5.1 install vusted
[Neovim repo](https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages),
[conventional commit guidelines](https://www.conventionalcommits.org/en/v1.0.0).

> [!caution]
>
> The commits will be linted on every push.
```COMMITMSG
type(scope): subject
Expand Down

0 comments on commit 16b24ab

Please sign in to comment.