Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 2.21 KB

File metadata and controls

49 lines (37 loc) · 2.21 KB

Contributing to ThreadMesh

ThreadMesh is currently specification-and-conformance-first. The repository also contains an experimental runtime, but contributions should turn observed behavior into portable semantics and negative tests rather than expanding the prototype without a protocol boundary.

Before opening a pull request

  1. Read the vision, scope, and design principles.
  2. Search existing issues and Architecture Decision Records.
  3. Read the current status and mainline plan.
  4. Open a design issue before proposing a protocol-breaking change or a new coordination intent.
  5. Keep one pull request focused on one coherent outcome.

Change categories

  • Editorial: clarity, grammar, navigation, examples; no semantic change.
  • Specification: protocol fields, operations, lifecycle, or required behavior.
  • Safety: permissions, consent, privacy, threat mitigations, or defaults.
  • Adapter: harness-specific mapping or conformance behavior.
  • Implementation: reference runtime, SDK, CLI, inspector, or tests.

Specification and safety changes should include:

  • the use case and failure mode;
  • compatibility impact;
  • security and context-sovereignty impact;
  • at least one positive and one negative example;
  • an ADR when the decision is durable or difficult to reverse.

Documentation style

  • Use plain, precise language.
  • Use MUST, SHOULD, and MAY only for normative protocol requirements.
  • Distinguish current behavior from proposals.
  • Do not claim compatibility with a harness without a testable adapter or primary-source reference.
  • Do not close a normative issue with trusted-process prototype evidence alone.
  • Prefer small examples that expose failure behavior, not only the happy path.

Commits and pull requests

  • Use imperative, descriptive commit subjects.
  • Explain why the change is needed in the pull request body.
  • Link the issue or ADR when applicable.
  • Update CHANGELOG.md for user-visible changes after versioning begins.

By participating, you agree to follow the Code of Conduct.