Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add info about typos package to contribution guide #37

Merged
merged 1 commit into from
Nov 21, 2024
Merged

add info about typos package to contribution guide #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions contribution-guides/contribute-as-developer.md
View file
Open in desktop
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