From 3cbd4cede861a6db72c74d3ca385c5692b077754 Mon Sep 17 00:00:00 2001 From: gibbz00 Date: Thu, 2 May 2024 07:37:26 +0200 Subject: [PATCH] docs(contributiing): add recommended LSPs --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96ccc4c..66be8c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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`: @@ -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