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.

Sign up for GitHub

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

Jump to bottom

Contriuting.md - document turning on and off strict mode #2156

Merged
merged 1 commit into from
Dec 1, 2024
+9 −4
Merged

Contriuting.md - document turning on and off strict mode #2156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ which you can spin up using docker-compose:
docker compose up -d --force-recreate
```

Note: If you're using Apple Silicone Macbooks, you need to enable "Use Rosetta for x86_64/amd64 emulation on Apple Silicon" since there is no ARM64 image for postgis yet.
Note: If you're using Apple Silicone Macbooks (M1, M2, etc), you need to enable "Use Rosetta for x86_64/amd64 emulation on Apple Silicon" since there is no ARM64 image for postgis yet.

After that, in SBT you can run `test` to run tests, and `makeSite` to build the doc site
With the containers started, SBT you can run `test` to run tests, and `makeSite` to build the doc site.

If you're editing code generation related code, you should reload the SBT project and then run the `freeGen2` SBT task
before compiling or running tests.
## Fixing warnings

To improve code quality and bug, we enable many stricter scala compiler flags via the
[sbt-tpolecat](https://github.com/typelevel/sbt-tpolecat) plugin and in CI all warnings will be treated as errors.

For a more pleasant development experience, we default to `tpolecatDevMode` so warnings do not cause compilation errors.
You can use the sbt command `tpolecatCiMode` to enable strict mode and help catch any warnings you missed.

## Caveats when working on the code

Expand Down