mirror of
https://github.com/TheRealOwenRees/chess-endgame-trainer.git
synced 2026-11-18 03:32:06 +00:00
update docs with static analysis tools
This commit is contained in:
@@ -50,6 +50,9 @@ Read `CODING_STANDARDS.md` before writing code. Read the section for the layer y
|
||||
|
||||
Run `mix precommit` and fix what it flags.
|
||||
|
||||
Type-check risky changes with `mix dialyzer` (not part of `mix precommit`; the
|
||||
first run builds a PLT and is slow).
|
||||
|
||||
## Agent skills
|
||||
|
||||
### Issue tracker
|
||||
|
||||
@@ -116,3 +116,17 @@ How to write code in this repo. Read the section for the layer you're touching.
|
||||
## Precommit
|
||||
|
||||
`mix precommit` runs `compile --warnings-as-errors`, `deps.unlock --unused`, `format` and `test`.
|
||||
|
||||
## Type checking (Dialyzer)
|
||||
|
||||
`dialyxir` is available in dev/test; run:
|
||||
|
||||
mix dialyzer
|
||||
|
||||
It is intentionally **not** part of `mix precommit`: the first run builds a PLT
|
||||
(several minutes), though subsequent runs are fast. The PLT lives under
|
||||
`_build/` (gitignored).
|
||||
|
||||
Treat warnings as bugs — add `@spec`s or fix them. Only suppress with
|
||||
`@dialyzer` or `.dialyzer_ignore.exs` when accompanied by a comment explaining
|
||||
why.
|
||||
|
||||
Reference in New Issue
Block a user