clockworklabs / clockworklabs/SpacetimeDB
Docs - Subscription Semantics
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
Discussion on Discord revealed that there's some confusion among the public about the semantics of subscriptions and how they are processed in the SDK. We should write up a formal-ish spec describing how, when and where subscriptions are processed, with an eye to:
- What work is done by the host vs the SDK.
- What timing and ordering guarantees do and don't exist.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Discord discussion to understand the reported confusion, then inspect the repository's existing documentation and SDK subscription materials. Done means a formal specification clearly describes where subscriptions are processed, host versus SDK responsibilities, and timing and ordering guarantees, including what is not guaranteed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100