Skip to content

Commit

Permalink
docs: add info about typos to contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
prettyirrelevant authored and kelsos committed Nov 21, 2024
1 parent 5da9ab8 commit 8bb8295
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions contribution-guides/contribute-as-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,22 @@ Set your editor up to use isort as seen in the Makefile (format command) before

You can also bulk apply formatting changes to all files by running `make format`.

To catch spelling mistakes before pushing, you can install [typos](https://github.com/crate-ci/typos). The CI will check for typos, so running it locally can help avoid CI failures:

```sh
cargo install typos-cli # or other installation methods from the docs
typos # check for typos
typos -w # automatically fix typos
```

If you encounter false positives, add exceptions in `_typos.toml`:

```toml
[default.extend-words]
# Add exceptions for names, technical terms, etc
teh = "teh" # Example: preserving "teh" as a surname
```

## Where to make changes

- If you want to contribute by fixing a bug, use the [bugfixes](https://github.com/rotki/rotki/tree/bugfixes) branch.
Expand Down

0 comments on commit 8bb8295

Please sign in to comment.