Contributing

Thanks your help with building Firemodel!

Code

Firemodel is written in go 1.10.

go get -t -u github.com/visor-tax/firemodel/...

There are no other system dependencies required to develop or build firemodel.

Firemodel uses standard go test for unit tests.

go test ./...

These tests also run in CircleCI.

The majority of test coverage is based on generated fixtures.

Typical workflow:

Implement new feature.
Run tests: go test.
Review fixture diff.
If changes are acceptable, regenerate fixtures: FIREMODEL_UPDATE_FIXTURES=true go test ./....
Commit code changes and fixture updates in a single commit.

Firemodel is still in early development. There are not yet regular releases.

To cut a new binary release on GitHub, use release.sh.

Version numbers should use semver, and breaking changes—both to the CLI as well as to the firemodel output—should be avoided.