Skip to content

Commit

Permalink
docs(contributiing): add recommended LSPs
Browse files Browse the repository at this point in the history
  • Loading branch information
gibbz00 committed May 2, 2024
1 parent ed88116 commit 3cbd4ce
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ There are some things that should be kept in mind when contributing to this proj

Structure requirements on commit messages, issues and pull requests are other than that pretty relaxed, (for now 🤞).

### Recommended developer tools:

##### LSPs

* [`typos-lsp`](https://github.com/tekumara/typos-lsp)
* [`taplo`](https://github.com/tamasfe/taplo)
* [`rust-analyzer`](https://github.com/rust-lang/rust-analyzer)

### Using pre-commit hooks

Using a pre-commit hook to locally check simpler CI validation steps is encouraged to avoid squash commit requests by the maintainers, but also `git commit --amend && git push --force` abuse. This can be achieved by pasting the following into `.git/hooks/pre-commit`:
Expand All @@ -30,6 +38,9 @@ cargo clippy --all-features --tests -- -D warnings
# Check documentation
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --all-features

# Typos
typos

# Some may also want to uncomment:
# cargo test --all-features
# mdbook test
Expand Down

0 comments on commit 3cbd4ce

Please sign in to comment.