Skip to content

suggest to run codespell before creating PRs. #3275

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

Open
fujitatomoya wants to merge 1 commit into
base: master
Choose a base branch
from
+22 −0
Open

suggest to run codespell before creating PRs. #3275

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
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,28 @@ Submit a pull request at any time, whether an issue has been created or not. It

Please follow the [SRT Developer's Guide](docs/dev/developers-guide.md).

## Spell Check

Before submitting a pull request, we should run codespell locally to check for spelling errors.
This helps ensure your PR passes the automated checks.

```console
# create python venv
python3 -m venv .venv

# activate venv
source .venv/bin/activate

# install codespell in venv
pip install codespell

# run codespell with config
codespell --config scripts/codespell/codespell.cfg

# deactivate venv
deactivate
```

## Code Style

Please follow existing style.
Expand Down
Loading