Contributing to Telmoni

Telmoni's open-source core is telmoni/telmoni on GitHub, the four SDKs under sdk/ with it; these pages are telmoni/docs, the CLI is telmoni/telmoni-cli, and the agent skills telmoni/skills. Thanks for helping build it. Everyone taking part follows the Code of Conduct, and the AI policy says how AI tools fit in.

Four repositoriesCopy Anchor Link

• telmoni/telmoni, the platform and the four SDKs (sdk/). Developing it takes two commands; ARCHITECTURE.md explains how it is built on one page: the place to read before changing anything structural. make ci is the gate.
• telmoni/docs, these pages, which the platform's console serves at /docs. The docs says how a page is wired, and every claim on one is checked against the code first. make check and typos are the gate, with the platform checked out beside it.
• telmoni/telmoni-cli, the CLI. Developing it; its ARCHITECTURE.md explains how it is built on one page. cargo xtask ci is the gate.
• telmoni/skills, the agent skills. Developing them; its AGENTS.md holds the rules a skill is held to, and how to test one. make check is the gate.

Before you startCopy Anchor Link

Open an issue first for a new feature, a schema change or anything architectural, so the shape is agreed before the work. A bug fix or a small improvement can go straight to a pull request.

How the platform's code is shapedCopy Anchor Link

• Rust owns the rules. Business logic, queries, authorization, tenancy and the audit log live in crates/; the console in web/ is a thin proxy and holds none of them.
• Never log a secret or personal data, at any level. Secrets are held in Redacted and read on purpose.
• Nothing has shipped, so there are no migration paths: a schema change edits the module's existing migration, and make db-reset rebuilds the local database. After a change to the wire contract, make contract regenerates it.

Before you pushCopy Anchor Link

Run the repository's gate, which is what its CI runs: make ci in the platform (formatting, clippy, rustdoc, the Rust tests against a local Postgres and ClickHouse, the console's typecheck, lint, dead-code check, tests and build, the SDK suites, and the dependency and spelling checks), make check and typos in the docs, cargo xtask ci in the CLI, and make check in the skills, CI linting the CLI's and the skills' workflows with actionlint beside them. A pull request is reviewed once its gate passes.

Commits and pull requestsCopy Anchor Link

• Keep a pull request to one change.
• Commits follow Conventional Commits (feat:, fix:, docs:, refactor:, chore:).
• Every commit is signed off by its author: git commit -s adds Signed-off-by: Your Name <you@example.com> from git's user.name and user.email, certifying the Developer Certificate of Origin, that you may submit the change under the project's Apache-2.0 licence, as its section 5 provides. A pull request with a commit not signed off is sent back to be signed, and the merge commit is signed off too: a maintainer merges from a clone with git merge --no-ff --signoff and pushes, never from GitHub's merge button, whose commit carries none.
• Only people are commit authors; the AI policy has the rest.

SecurityCopy Anchor Link

A suspected vulnerability is never a public issue: see reporting a vulnerability, which is the security policy of every Telmoni repository.