Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (34 loc) · 976 Bytes

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 976 Bytes

Contributing to IronRoot

Development setup

Install Go, Podman, and Python with MkDocs Material.

go mod download
make build

Tests

make test
make test-e2e
make coverage

Documentation

make docs-serve
make docs-build

Coding conventions

  • Keep interfaces small and storage implementations replaceable.
  • Do not generate workload private keys on the server.
  • Prefer structured logs with component and operation fields.
  • Add tests for PKI, enrollment, storage, and telemetry behavior.
  • Run make lint before opening a pull request.

Pull requests

Open focused pull requests with clear motivation, tests, and documentation updates when behavior changes.

Commit messages

Use concise imperative messages, for example:

Add bootstrap token validation
Document root migration flow

Review expectations

Reviews prioritize security boundaries, operational clarity, test coverage, and maintainability.