Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.56 KB

File metadata and controls

30 lines (18 loc) · 1.56 KB

Contributing to ASMTP

ASMTP is an open protocol. Contributions are welcome — spec edits, schema improvements, conformance tests, reference implementations, examples.

Channels

  • File issues on this repo for spec questions, schema bugs, or proposals.
  • Pull requests against WHITEPAPER.md and the schemas are welcomed, especially with worked examples or conformance tests demonstrating the change.

Bar for wire-format changes

Wire format is hard to change after adoption. New wire-affecting proposals should:

  1. State the problem in one paragraph, with at least one concrete scenario where the current spec is wrong or insufficient.
  2. Show the diff — what fields are added, removed, or changed; what error codes shift; what conformance bar moves.
  3. Update or add a conformance test that fails on the current spec and passes on the proposal.
  4. Address backward compatibility. While ASMTP is in v0.x, breaking changes are admissible. Once v1.0, they are not without a version increment.
  5. Engage the inherited-from-ASP boundary explicitly. ASMTP inherits identity and trust from ASP. Proposals touching those layers should be made to ASP, not ASMTP.

Bar for schema and reference-implementation changes

Smaller. PRs that fix schema bugs, improve example clarity, or extend the conformance suite are usually fine to land directly after review.

Security

If you find a security-relevant issue in the spec or in the reference operator, please follow SECURITY.md.

Code of conduct

See CODE_OF_CONDUCT.md.