Skip to content

Add RFC implementation status roadmap to README#31

Merged
codingjoe merged 7 commits intomainfrom
copilot/add-table-to-readme
Mar 13, 2026
Merged

Add RFC implementation status roadmap to README#31
codingjoe merged 7 commits intomainfrom
copilot/add-table-to-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 13, 2026 •
edited
Loading

Adds a "Roadmap" section to the README with grouped tables tracking the implementation status of RFCs relevant to this VoIP library, covering both already-implemented standards and planned work.

Changes

  • README.md — new ## Roadmap section with RFC tables grouped into themed sections: SIP Signaling, Media Transport, IVR and Application Services, Voicemail, and Telephony Routing
  • A Notes column provides specific implementation detail for each RFC (e.g. which payload types, which auth algorithms, which SDP fields)
  • All actually-implemented RFCs are now included with accurate status:
    • RFC 3261 (SIP) → 🚧 Partial — UAC only; REGISTER, INVITE, BYE, digest auth over TLS/TCP
    • RFC 3550 (RTP) → ✅ Complete — full packet parsing and per-call multiplexing
    • RFC 3551 (RTP audio profile) → 🚧 Partial — PCMU, PCMA, G.722, Opus payload types
    • RFC 3711 (SRTP) → ✅ Complete — AES-CM-128-HMAC-SHA1-80
    • RFC 3533 (Ogg) → 🚧 Partial — minimal Ogg page writer for Opus export
    • RFC 4566 (SDP) → 🚧 Partial — offer/answer for audio calls
    • RFC 4568 (SDES) → ✅ Complete — inline SRTP key exchange via a=crypto:
    • RFC 5389 (STUN) → ✅ Complete — Binding Request/Response, XOR-MAPPED-ADDRESS
    • RFC 5626 (SIP outbound keepalives) → 🚧 Partial — double-CRLF ping/pong
    • RFC 7587 (Opus RTP) → ✅ Complete — dynamic payload type 111
    • RFC 7983 (STUN/RTP mux) → ✅ Complete — first-byte demultiplexing
    • RFC 8760 (SIP digest auth with SHA-256) → ✅ Complete — MD5, SHA-256, SHA-512/256
  • Planned RFCs from the issue are retained and annotated (ENUM, tel URI, DTMF, IVR, voicemail, telephony routing)
  • MGCP RFCs (2805, 3435, 3660, 3661, 3991) removed — separate protocol stack not in scope for a SIP UAC library
  • All links use consistent https://datatracker.ietf.org/doc/html/rfcXXXX format
Original prompt

This section details on the original issue you should resolve

<issue_title>Readmap</issue_title>
<issue_description>Let's add small table to the readme file with the implementation status of the relevant RFCs. Those are the once I have in mind, but there might be more:

Comments on the Issue (you are @copilot in this section)

Custom agent used: SuperJoe
CodingJoe's digital clone following his coding guidelines and best practices.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 13, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.69%. Comparing base (d4e46e3) to head (b184fe7).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #31   +/-   ##
=======================================
  Coverage   93.69%   93.69%           
=======================================
  Files          16       16           
  Lines        1348     1348           
=======================================
  Hits         1263     1263           
  Misses         85       85

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI changed the title [WIP] Add implementation status table for relevant RFCs to README Add RFC implementation status roadmap to README Mar 13, 2026
Copilot AI requested a review from codingjoe March 13, 2026 22:30
codingjoe
codingjoe reviewed Mar 13, 2026
View reviewed changes
Copy link
Copy Markdown
Owner

@codingjoe codingjoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot I am missing stuff like RFC 8760, RTP, STUN, and more, which are implemented. Please also reason which standards actually make sense for this package.

README.md Outdated

| RFC | Title | Status |
|-----|-------|--------|
| [RFC 3261](https://datatracker.ietf.org/doc/html/rfc3261) | SIP: Session Initiation Protocol | 🚧 Partial |
Copy link
Copy Markdown
Owner

@codingjoe codingjoe Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's give a little more meaningful insight.

Copy link
Copy Markdown
Contributor Author

Copilot AI Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a Notes column in b21f067 that describes what's specifically implemented (or not) for each RFC — e.g. RFC 3261 now reads "UAC only; REGISTER, INVITE, BYE, and digest authentication over TLS/TCP".

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 13, 2026

@copilot I am missing stuff like RFC 8760, RTP, STUN, and more, which are implemented. Please also reason which standards actually make sense for this package.

Added in b21f067. The Roadmap now includes all implemented RFCs — RFC 3550 (RTP), RFC 3551 (RTP audio profile), RFC 3711 (SRTP), RFC 4566 (SDP), RFC 4568 (SDES), RFC 5389 (STUN), RFC 7983 (mux), RFC 7587 (Opus), RFC 8760 (digest auth), RFC 5626 (keepalives), and RFC 3533 (Ogg).

The table is also grouped by category (SIP Signaling, Media Transport, IVR, Voicemail, Telephony Routing) and has a Notes column explaining what each entry covers. I dropped the MGCP RFCs (2805, 3435, 3660, 3661, 3991) as they represent a separate protocol stack not in scope for a SIP UAC library.

Copilot AI requested a review from codingjoe March 13, 2026 22:42
@codingjoe
Copy link
Copy Markdown
Owner

codingjoe commented Mar 13, 2026

pre-commit.ci run

@codingjoe codingjoe marked this pull request as ready for review March 13, 2026 22:52
Copilot AI review requested due to automatic review settings March 13, 2026 22:52
@codingjoe codingjoe merged commit 7cbd410 into main Mar 13, 2026
20 checks passed
@codingjoe codingjoe deleted the copilot/add-table-to-readme branch March 13, 2026 22:52
Copilot AI reviewed Mar 13, 2026
View reviewed changes
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a "Roadmap" section to the README with tables tracking RFC implementation status, grouped by topic area (SIP Signaling, Media Transport, IVR, Voicemail, Telephony Routing).

Changes:

  • Added RFC roadmap tables to README.md documenting implemented and planned standards
  • Removed out-of-scope MGCP RFCs from the original issue's list
  • Annotated implemented RFCs with specific implementation details

You can also share your feedback on Copilot code review. Take the survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@codingjoe codingjoe Awaiting requested review from codingjoe

Assignees

@codingjoe codingjoe

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Readmap

3 participants

@codingjoe