Skip to content

Quality requirements

Justin "J.R." Hill edited this page Dec 20, 2023 · 1 revision

Quality requirements

Static analysis tools

An SDK should ship with basic static analysis tools. These should be at the least:

  1. A test runner for unit tests against the SDK in isolation
  2. A linter that can fail a build for code that is not formatted idiomatically, and
  3. A formatter that can automatically format code to some idiomatic format

These tools should be test/development dependencies, and should not be inherited or required by end users of the SDK.

Continuous development

OpenFGA is hosted on GitHub and makes use of GitHub Actions for its CI/CD workflows.

TODO: Point to example build/publish CI workflows