Contributing

August 2, 2026 ยท View on GitHub

HELM is maintained as a small OSS kernel. Contributions should improve the retained public surface, not reintroduce removed product or marketing scope.

If you are new, start with a scoped issue: good first issue. Ask setup questions in Discussions before opening a large PR.

Local Setup

git clone https://github.com/Mindburn-Labs/helm-ai-kernel.git
cd helm-ai-kernel
make build

Validation Before a PR

make quality-pr

Run make quality-impact for a quick path-scoped package pass, or use focused targets such as make quality-contracts, make quality-security, or make quality-typecheck for the area you changed. Before merge or release, maintainers use make quality-merge and make quality-release.

First Contribution Paths

PathGood first workFocused validation
DocsClarify quickstart, MCP, proxy, receipt, or verifier text.make docs-coverage docs-truth
ExamplesAdd or polish localhost fixtures for ALLOW, DENY, and ESCALATE.make launch-smoke or a focused launch demo
MCPImprove quarantine, schema-pin, or authorization examples.bash scripts/launch/demo-mcp.sh
ProxyImprove OpenAI-compatible base URL examples.bash scripts/launch/demo-openai-proxy.sh
ReceiptsAdd verification or tamper-failure fixtures.bash scripts/launch/demo-proof.sh
SDKsPolish first-run SDK examples.make sdk-examples-smoke or a focused SDK target

Public contribution lanes and community expectations are in COMMUNITY.md. The ecosystem map for upstream work is in docs/ECOSYSTEM.md.

Issue Labels

  • good first issue is scoped and newcomer-safe.
  • help wanted is contributor-ready, but may need more context or maintainer review.
  • maintainer-task requires maintainer, operator, or release access and is not externally claimable.

Contribution Rules

  1. Keep documentation tied to code, tests, or release automation.
  2. Do not merge incomplete behavior, backlog markers, or deferred public copy.
  3. Keep the OSS scope tight: kernel, CLI, contracts, SDKs, and the retained deployment/examples surface.
  4. Preserve deterministic verification paths when changing receipts, schemas, or evidence handling.

Contribution License

Contributions are accepted under the repository license (Apache-2.0). There is no CLA or copyright assignment.

Pull Requests

  • Keep PRs narrow and reviewable.
  • Include the commands you ran.
  • Update docs only when the implementation or release truth changes.
  • Link the issue or discussion that explains the user-facing value.
  • Keep launch and community copy factual: no unsupported SaaS, hosted control-plane, certification, or production-security claims.

Merge authority (build-fast, 2026-08-01)

Merge authority is green required checks on the pull request's current merge commit, for agents and humans alike, with all review threads resolved. CI checks are deterministic (build/test/lint/contract-drift); no per-PR model-review or Copilot-billed checks run in the delivery path. The 2-of-2 machine-authority program continues as on-demand R&D in contracts-autonomous-release-lab/-canary only and is not a merge requirement here. Package publishes and release tags require one owner approval. The live main protection ruleset is the enforcement source; .github/TEST_MATRIX.md records its inspected configuration (Linear HELM-432).

Security Reports

Use the process in SECURITY.md, not public issues.