How to contribute

Each repository takes issues and pull requests on its own. Read the contributing guide of the repository a change belongs to: loquitur-protocol, loquitur-schemas, loquitur-verify-py or loquitur-verify-ts. The docs/maintainers/ directory of each says how to run its checks.

Start with an issue

External contributions start with an issue. A pull request is welcome under the Developer Certificate of Origin when it is tied to an issue the maintainer has accepted. A normative change to the protocol goes through the LCP change-proposal register of loquitur-protocol, docs/change-proposals.md.

Included from loquitur-protocol/CONTRIBUTING.md, “Contributions during the preview”. MIT OR Apache-2.0.

A normative change is classified and decided as GOVERNANCE.md says, and recorded in the change-proposal register.

What a pull request states

A good pull request is small, reviewable, and tied to one public specification concern.

State in the pull request:

1. which public spec surface changes;
2. whether any public claim changes;
3. what boundary risk was considered;
4. what checks were run;
5. what remains unverified.

The pull request template (.github/PULL_REQUEST_TEMPLATE.md) asks for these five statements as a checklist, and the issue forms (.github/ISSUE_TEMPLATE/) cover a specification question or error and a change proposal.

Run the checks as docs/maintainers/testing.md says before you open the pull request; CI runs the same suite.

Do not add private evidence, third-party material, credentials, package source, service runtime code, or documentation-site, website or user-interface application code to this repository.

Included from loquitur-protocol/CONTRIBUTING.md, “Pull request expectations”. MIT OR Apache-2.0.

Developer Certificate of Origin

Contributions are made under the Developer Certificate of Origin 1.1 (https://developercertificate.org/). Every commit, the maintainer’s own included, carries a sign-off line whose name and address match the commit’s author, and CI checks every commit of a push or pull request for it. git commit -s adds the line:

Signed-off-by: Your Name <your.email@example.com>

A squash merge made in the GitHub web interface can drop the Signed-off-by trailer of the commits it combines: whoever merges adds the trailer back to the squashed commit’s message.

The sign-off certifies that the contributor wrote the change or otherwise has the right to submit it under the licenses the next section names. There is no separate contributor agreement.

Included from loquitur-protocol/CONTRIBUTING.md, “Developer Certificate of Origin”. MIT OR Apache-2.0.

This site

The pages of this site are built from the four repositories at the release tag. A mistake in a rendered or included text is fixed in the repository it comes from.