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.

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

A few tiny documentation fixes with regards to development #27

Merged
merged 1 commit into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@ See the [`InsertAndWork` example] for complete code.

- [Work functions] for simplified worker implementation.

See also [developing River].
# Development

See [developing River].

[`Client`]: https://pkg.go.dev/github.com/riverqueue/river#Client
[`Client.InsertTx`]: https://pkg.go.dev/github.com/riverqueue/river#Client.InsertTx
Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,9 @@ See the [`InsertAndWork` example] for complete code.

- [Work functions] for simplified worker implementation.

See also [developing River].
## Development

See [developing River].

[`Client`]: https://pkg.go.dev/github.com/riverqueue/river#Client
[`Client.InsertTx`]: https://pkg.go.dev/github.com/riverqueue/river#Client.InsertTx
Expand Down
12 changes: 4 additions & 8 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# River
# River development

River is an experimental Postgres queue for Go.

## Development

### Run tests
## Run tests

Raise test databases:

Expand All @@ -14,13 +10,13 @@ Run tests:

go test ./... -p 1

### Run lint
## Run lint

Run the linter and try to autofix:

golangci-lint run --fix

### Generate sqlc
## Generate sqlc

The project uses sqlc (`brew install sqlc`) to generate Go targets for Postgres
queries. After changing an sqlc `.sql` file, generate Go with:
Expand Down