Contributing Overview
ProtocolSoup welcomes contributions that help practitioners understand real identity and security protocol behavior. The project favors authentic protocol execution, complete Looking Glass visibility, and changes that keep the platform easy to extend.
First Steps
Section titled “First Steps”- Read the repository contributing guide.
- Check existing issues and discussions before starting significant work.
- Comment on the issue you want to take so maintainers and other contributors can coordinate.
- Fork the repository and branch from
master. - When practical, sign commits with
git commit -s(DCO). If you forget, say so in the PR—maintainers can help before merge. There is no automated DCO gate.
Best Starter Work
Section titled “Best Starter Work”- Documentation fixes that clarify real setup, API behavior, or protocol flows.
- Small UI improvements with screenshots or Looking Glass output.
- Focused backend bug fixes with targeted tests.
- Protocol proposals that cite the relevant RFCs, OpenID specifications, W3C specifications, or OASIS standards.
Contribution Paths
Section titled “Contribution Paths”- Development Setup - install tools, run services, and validate changes locally.
- Pull Request Workflow - prepare a reviewable PR and understand maintainer expectations.
- Add A Protocol - extend ProtocolSoup with a new protocol plugin.
What Maintainers Look For
Section titled “What Maintainers Look For”- Real protocol execution rather than placeholders or mocked-looking payloads.
- Clear Looking Glass events for meaningful protocol steps.
- Spec references for protocol behavior and security-sensitive choices.
- Focused changes that do not mix unrelated refactors with feature work.
- Documentation updates when behavior, setup, APIs, configuration, or contributor workflow changes.