Development

Source: BramVR/goBankCli.

Use the repository Makefile:

make fmt
make test
make lint
make docs-commands
make docs-test
make docs-site
make docs-site-test
make ci

Add tests next to the package they cover. Use testdata for provider fixtures. Do not commit real bank data, live credentials, or copied bank exports.

Command reference pages are generated from the CLI surface. When command behavior changes, run make docs-commands, update the matching topic doc and README examples when they are affected, then run make docs-test. Every doc under docs/ must keep summary and read_when frontmatter so the shared docs inventory can route future work.

The Project Site build renders an explicit allowlist of committed docs into dist/docs-site. Keep planning, ADR, agent, and research notes off that allowlist unless they are intentionally public.

Before opening a docs PR, run:

make docs-site
make docs-site-test
go test ./...
go vet ./...

Run the docs inventory helper too when your local workspace has one configured. For public docs changes, also audit dist/docs-site, README, examples, and changed fixtures for real bank data or credentials.