Contribute
How to file issues, propose protocol changes, and help build the reference resolver.
OLPN is an open protocol. The reference resolver, the protocol documents, and this site are all openly licensed. Contributions are welcome in a few different forms.
File an issue against the spec
If you spot an ambiguity in the spec, a contradiction between the docs and the reference resolver's behavior, or a missing piece of the schema, file a specification issue. Be specific about which document and which field, and link to the exact sentence or JSON shape you're questioning.
Propose a protocol change
Breaking changes to document shape, identifier format, or verification rules require a protocol version bump. Propose them as a draft: describe the change, the motivation, the migration path for existing entities, and the resolver behavior during the transition.
Small, backward-compatible additions (new optional fields, new document types layered on existing endpoints) follow a lighter process: propose, discuss, ship.
Contribute to the reference resolver
The reference resolver is in Go. Typical contributions:
- Bug fixes (parser edge cases, regex quirks, content-type handling).
- New output formats (a JSON API response alongside the HTML page).
- Performance improvements (caching with respect of HTTP cache headers, parallel fetches).
- Test coverage (the codebase is sparse on tests).
Contribute to these docs
Found a stale fact, a missing example, a confusing paragraph? The docs live in a Ghost site, not a Git repo, so the contribution path is:
- File an issue in the protocol repo describing what needs to change.
- Include the exact current text and your proposed replacement.
- One of the docs editors will apply the change.
If you would rather have docs-as-code for pull requests, say so in an issue. Moving the docs to a Git-hosted static site generator is a reasonable ask; it's not the current state.
Implement OLPN in your stack
The most valuable contribution is a working implementation on a new platform. Add OLPN to a WordPress plugin, a static-site generator, a CMS, a hosting provider, a legal directory. Publishing documentation on how you did it (even just a blog post) adds leverage for everyone else.
If you do ship an integration, let us know so we can link it from the Implementation guides.
Code of conduct
The usual: be civil, be specific, assume good faith, credit other people's work. Bad-faith engagement is not welcome. Disagreements about protocol design are fine and expected; disagreements about character and identity are not what this space is for.