Skip to content

Commit e3dbfc2

Browse files
authored
Merge pull request #2156 from typelevel/contributingmd_strict_mode
Contriuting.md - document turning on and off strict mode
2 parents c2c195e + f255ae5 commit e3dbfc2

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,17 @@ which you can spin up using docker-compose:
1111
docker compose up -d --force-recreate
1212
```
1313

14-
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.
14+
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.
1515

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

18-
If you're editing code generation related code, you should reload the SBT project and then run the `freeGen2` SBT task
19-
before compiling or running tests.
18+
## Fixing warnings
19+
20+
To improve code quality and bug, we enable many stricter scala compiler flags via the
21+
[sbt-tpolecat](https://github.com/typelevel/sbt-tpolecat) plugin and in CI all warnings will be treated as errors.
22+
23+
For a more pleasant development experience, we default to `tpolecatDevMode` so warnings do not cause compilation errors.
24+
You can use the sbt command `tpolecatCiMode` to enable strict mode and help catch any warnings you missed.
2025

2126
## Caveats when working on the code
2227

0 commit comments

Comments
 (0)