mirror of
https://github.com/go-sylixos/elvish.git
synced 2024-11-28 07:21:21 +08:00
CONTRIBUTING: Add instruction for running all checks.
This commit is contained in:
parent
ab59ef9062
commit
214dafef56
|
@ -132,7 +132,11 @@ Use the standard command, `go generate ./...` to regenerate all files.
|
|||
Some of the generation rules depend on the `stringer` tool. Install with
|
||||
`go install golang.org/x/tools/cmd/stringer@latest`.
|
||||
|
||||
## Formatting source files
|
||||
## Code hygiene
|
||||
|
||||
Some basic aspects of code hygiene are checked in the CI.
|
||||
|
||||
### Formatting
|
||||
|
||||
Install [goimports](https://pkg.go.dev/golang.org/x/tools/cmd/goimports) to
|
||||
format Go files, and [prettier](https://prettier.io/) to format Markdown files.
|
||||
|
@ -149,7 +153,7 @@ automatically when saving Go or Markdown sources.
|
|||
Use `make checkstyle` to check if all Go and Markdown files are properly
|
||||
formatted.
|
||||
|
||||
## Linting
|
||||
### Linting
|
||||
|
||||
Install [staticcheck](https://staticcheck.io):
|
||||
|
||||
|
@ -163,9 +167,10 @@ use golint since it is
|
|||
|
||||
Use `make lint` to run `staticcheck` and `go vet`.
|
||||
|
||||
## Checking spelling
|
||||
### Spell checking
|
||||
|
||||
Install [codespell] to check spelling:
|
||||
Install [codespell](https://github.com/codespell-project/codespell) to check
|
||||
spelling:
|
||||
|
||||
```sh
|
||||
pip install --user codespell==2.1.0
|
||||
|
@ -173,6 +178,17 @@ pip install --user codespell==2.1.0
|
|||
|
||||
Use `make codespell` to run it.
|
||||
|
||||
### Running all checks
|
||||
|
||||
Use this command to run all checks:
|
||||
|
||||
```sh
|
||||
make test checkstyle lint codespell
|
||||
```
|
||||
|
||||
You can put this in `.git/hooks/pre-push` to ensure that your published commits
|
||||
pass all the checks.
|
||||
|
||||
## Licensing
|
||||
|
||||
By contributing, you agree to license your code under the same license as
|
||||
|
|
Loading…
Reference in New Issue
Block a user