By participating you agree to the Code of Conduct.
To integrate Proofable into a product, start at docs.proofable.me. This page is for changes to this repository.
| Need | Where |
|---|---|
| Possible bugs | Issues |
| Ideas and questions | Discussions |
| Security reports | dev@proofable.me (do not post publicly) |
| Release notes | CHANGELOG.md |
The published documentation, the OpenAPI description, and the public verifier catalog. Client code lives in proofable/sdk; the MCP package, plugins and skills live in proofable/mcp.
- Corrections where a page no longer matches what the live product does.
- Verifier proposals that spell out the user-visible outcome you want.
- Runnable examples, and the errors a builder will actually hit.
Never share keys, tokens, bearer secrets, or private proof content in issues or pull requests, and never commit .env files, .npmrc files or key material.
Open a Discussion with the outcome you want verified. An accepted check ships once it is built into the Proofable service, and its schema then appears under verifiers/schemas/ and in verifiers/VERIFIERS.json. See Propose a verifier.
Put a user-facing note under ## [Unreleased] in CHANGELOG.md. Use Added, Changed, Deprecated, Removed, Fixed, or Security. Write what a builder will notice. Leave out ticket IDs and private repository names.
Say what builders or end users will experience differently, such as new fields, new errors, or renamed concepts. If you change a verifier or a documented HTTP surface, update the API reference and examples in the same pull request.