Skip to content

Add SignalR architecture overview - #69200

Merged
PureWeen merged 7 commits into
dotnet:mainfrom
PureWeen:shneuvil-signalr-contributor-guidance
Oct 3, 2026
Merged

PureWeen merged 7 commits into
dotnet:mainfrom
PureWeen:shneuvil-signalr-contributor-guidance

Conversation

@PureWeen

@PureWeen PureWeen commented Sep 10, 2026 •

Copy link
Copy Markdown
Member

Add SignalR architecture overview

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Add an in-area SignalR architecture overview for contributors.

Description

Adds src/SignalR/ARCHITECTURE.md, a reference document for contributors and coding agents working in src/SignalR. It follows the in-area ARCHITECTURE.md pattern established by @javiercn in #69147.

The content is durable SignalR knowledge extracted from the wider #69011 effort and checked against current code and tests on main, so SignalR area owners can review and validate it on its own.

  • documents how the SignalR server, transports, protocols, clients, and scaleout layers compose and who owns each
  • describes connection establishment, hub handshake, dispatch, lifetime, stateful reconnect, and close/abort/timeout boundaries
  • captures cross-client capability differences and architectural compatibility invariants
  • maps existing SignalR documentation and the verification (test) boundaries for each subsystem

Documentation only: one new file, no runtime, public API, or other documentation changes.

Validation

  • git diff --stat origin/main...HEAD: only src/SignalR/ARCHITECTURE.md (275 insertions).
  • git diff --check origin/main...HEAD passed.
  • All 35 relative links in the document resolve on disk.
  • Markdownlint was not run locally; the repository workflow only lints docs/**/*.md, so it does not cover this in-area document. Runtime tests were not run for this documentation-only change.

Related to #69011; this area extraction does not close the wider effort.

@PureWeen PureWeen changed the title Add SignalR contributor guidance Add SignalR architecture overview Sep 10, 2026
@PureWeen
PureWeen marked this pull request as ready for review September 11, 2026 03:43
Copilot AI lite review requested due to automatic review settings September 11, 2026 03:43

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Two documentation inaccuracies should be clarified before approval.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review tier: Lite
Findings: 1 Low severity

New issues introduced by this change (1)
Severity Finding
Low severity src/​SignalR/​ARCHITECTURE.md — Scope permissive parsing to implementation behavior
What changed in this PR

Adds a SignalR architecture overview covering subsystem composition, lifecycle behavior, protocols, transports, clients, and scaleout.

Changes:

  • Documents connection, dispatch, reconnect, and failure flows.
  • Describes client capabilities and architectural invariants.
  • Maps documentation and verification boundaries.
File Description
src/​SignalR/​ARCHITECTURE.md Adds the SignalR architecture and verification overview.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/SignalR/ARCHITECTURE.md Outdated
@Youssef1313 Youssef1313 added the area-signalr Includes: SignalR clients and servers label Sep 11, 2026
Copilot AI added 3 commits September 14, 2026 10:08
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@PureWeen
PureWeen force-pushed the shneuvil-signalr-contributor-guidance branch from 1aed1a9 to f114156 Compare September 14, 2026 15:08
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.

@dotnet-policy-service dotnet-policy-service Bot added the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Sep 26, 2026
Copilot AI added 2 commits October 1, 2026 15:51
…ributor-guidance

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@PureWeen
PureWeen requested a review from SamMonoRT as a code owner October 1, 2026 21:01
Keep this PR scoped to the SignalR architecture reference doc.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The documentation aligns with the implementation, and all relative link targets resolve.

Review effort: Balanced
Findings: None

Resolved since last review (1)

Comment thread src/SignalR/ARCHITECTURE.md
Comment thread src/SignalR/ARCHITECTURE.md Outdated
Comment thread src/SignalR/ARCHITECTURE.md
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@PureWeen
PureWeen merged commit dc8b384 into dotnet:main Oct 3, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-signalr Includes: SignalR clients and servers pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants