Contributing
CGP welcomes contributions to the protocol, reference implementation, privacy gateway, conformance suite, documentation, integrations and research.
Start with the correct channel
Section titled “Start with the correct channel”- Bug: use the Bug Report issue form.
- Implementation feature: use the Feature Request form.
- Protocol semantics: use the Protocol Proposal form.
- Documentation: use the Documentation form.
- Security vulnerability: report privately through GitHub Security Advisories.
Local validation
Section titled “Local validation”gofmt -w $(find . -name '*.go' -type f)go vet ./...go test -race ./...go build ./cmd/fcpd ./cmd/fcpctl ./cmd/fcpconform ./cmd/fcpprivacyDocumentation:
cd websitenpm installnpm run buildProtocol contributions
Section titled “Protocol contributions”Changes to wire formats, semantics, capabilities, conformance, compatibility, privacy state, trust boundaries or receipts require an RFC in docs/spec/.
An RFC must explain:
- the interoperability problem;
- normative behavior;
- compatibility and migration;
- security and privacy implications;
- conformance tests;
- rejected alternatives.
Data safety
Section titled “Data safety”Never submit real credentials, personal data, customer documents, production logs or proprietary fixtures. Use synthetic examples and sanitize every attachment.