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

chore: update CONTRIBUTING.md with sqlc guidance #2012

Merged
merged 1 commit into from
Jul 11, 2024
Merged
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
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,25 @@ switch t := t.(type) {

Then when a new case is added to the sum type, `go-check-sumtype` will detect the missing case statically.

### Database and SQL changes

If you make any changes to the `sqlc` inputs, i.e. all the `sql/queries.sql` files, the contents of `backend/controller/sql/schema`, or `sqlc.yaml`, then you will need to update the Go code that `sqlc` generates from those inputs:

```bash
just build-sqlc
```

## VSCode extension

The preferred way to develop the FTL VSCode extension is to open a VSCode instance in the `extensions/vscode` directory. This will load the extension in a new VSCode window. From there, the `launch.json` and `tasks.json` files are configured to run the extension in a new window.

## Building the extension
### Building the extension

```bash
just build-extension
```

## Packaging the extension
### Packaging the extension

To package the extension, run:

Expand All @@ -140,7 +148,7 @@ just package-extension

This will create a `.vsix` file in the `extensions/vscode` directory.

## Publishing the extension
### Publishing the extension

To publish the extension, run:

Expand Down
Loading