ADR-014: Code Quality

Status

Accepted

Follows the platform’s ADR-028: Code Quality.

Context

Consistent code is easier to review, and the SDK is developed beside the platform.

Decision

.pre-commit-config.yaml is the standard, with the platform’s hooks (black, isort, autoflake, flake8, bandit, pyupgrade, pydocstringformatter, codespell, prettier, commitlint), minus its React hooks. Rules aren’t disabled indiscriminately.

Alternatives Considered

  • A separate style for the SDK.

Consequences

  • Positive:

    • The SDK and the platform read alike.

  • Negative:

    • Hook versions must be kept in step with the platform’s.