-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3d398cb
commit 06e7eb1
Showing
2 changed files
with
55 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Development | ||
|
||
Periscope uses the standard [Go toolchain][golang] for development. | ||
|
||
[golang]: https://go.dev/ | ||
|
||
## Testing | ||
|
||
You can run the tests with: | ||
|
||
```bash | ||
go test ./... | ||
``` | ||
|
||
## Formatting | ||
|
||
You can run the code formatter with: | ||
|
||
```bash | ||
go fmt ./... | ||
``` | ||
|
||
## Static analysis | ||
|
||
You can run Go's built-in `vet` tool with: | ||
|
||
```bash | ||
go vet ./... | ||
``` | ||
|
||
This project additionally uses the [staticcheck] tool. You can install it with: | ||
|
||
```bash | ||
go install honnef.co/go/tools/cmd/staticcheck@latest | ||
``` | ||
|
||
You can run staticcheck with: | ||
|
||
```bash | ||
staticcheck -f stylish ./... | ||
``` | ||
|
||
[staticcheck]: https://staticcheck.dev/ | ||
|
||
## Building and installing | ||
|
||
You can build and install the `psc` binary locally with `go install ./cmd/psc`. | ||
|
||
## Continuous integration | ||
|
||
Testing and static analysis is [run in CI][ci-test]. Additionally, building and publishing binaries is [run in CI][ci-release]. | ||
|
||
[ci-test]: .github/workflows/ci.yml | ||
[ci-release]: .github/workflows/release.yml |