Skip to content

docs: add protocol development workflow guide#2149

Open
kuruk-mm wants to merge 2 commits into
mainfrom
docs/protocol-dev-workflow
Open

docs: add protocol development workflow guide#2149
kuruk-mm wants to merge 2 commits into
mainfrom
docs/protocol-dev-workflow

Conversation

@kuruk-mm
Copy link
Copy Markdown
Member

Summary

  • Adds docs/PROTOCOL_DEV_WORKFLOW.md describing how to land a protocol change across protocol, js-sdk-toolchain and godot-explorer.
  • Documents the role of protocol-squad vs main, the per-PR tarball flow, and the backward compatibility contract that keeps deployed scenes safe.
  • Includes a quick-reference table for which @dcl/protocol tag to depend on while iterating vs after a feature lands.

Test plan

  • Docs-only change — verify Markdown renders correctly on GitHub.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 20, 2026

📦 Build Report

🤖 Android

Artifact Status
APK 📱 Download APK
AAB 📦 Download AAB
Debug Symbols 🔧 Debug Symbols

Build Status: ✅ Success

🍏 iOS

iOS builds are triggered manually. Add the build-ios label to trigger an iOS build.


🔗 Workflow Run: View logs

🔄 Updated: 2026-05-20 17:13:27 UTC

Document the end-to-end process for shipping protocol changes across
protocol, js-sdk-toolchain, and godot-explorer, including the role of
protocol-squad as an iteration channel and the cherry-pick path to main.
@kuruk-mm kuruk-mm force-pushed the docs/protocol-dev-workflow branch from 30d194a to c7c1567 Compare May 20, 2026 16:37
Flow A is now "Straight to main" (default) and Flow B is "Through
protocol-squad" (legacy). Reorders the sections, swaps the recommendation
table and quick-reference, and updates cross-references so the protocol-squad
detour is positioned as a fallback for changes whose shape is still in flux.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant