Skip to content

Commit

Permalink
Add development guide
Browse files Browse the repository at this point in the history
  • Loading branch information
anishathalye committed Jan 4, 2025
1 parent 3d398cb commit 06e7eb1
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
- name: Test with Coverage
run: go test -v -coverprofile=coverage.txt -covermode=atomic ./...
run: go test -v -coverprofile=coverage.txt -covermode=atomic ./...
- uses: codecov/codecov-action@v5
with:
fail_ci_if_error: true
Expand Down
54 changes: 54 additions & 0 deletions DEVELOPMENT.md
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

0 comments on commit 06e7eb1

Please sign in to comment.