Skip to content

Contributing

CGP welcomes contributions to the protocol, reference implementation, privacy gateway, conformance suite, documentation, integrations and research.

  • 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.
Terminal window
gofmt -w $(find . -name '*.go' -type f)
go vet ./...
go test -race ./...
go build ./cmd/fcpd ./cmd/fcpctl ./cmd/fcpconform ./cmd/fcpprivacy

Documentation:

Terminal window
cd website
npm install
npm run build

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.

Never submit real credentials, personal data, customer documents, production logs or proprietary fixtures. Use synthetic examples and sanitize every attachment.