clockworklabs / clockworklabs/SpacetimeDB
pepper remarks about field ordering mattering throughout the docs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
Struct field ordering and enum variant ordering are semantically meaningful, this should be remarked on somewhere or other.
SpacetimeDB WILL warn users if they try to change field ordering -- they'll get a schema validation error -- but it would still be good to mention.
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
The issue names no file, test, or documentation entry point. Start by locating the docs covering struct fields, enum variants, and schema validation, then add a note explaining that their ordering is semantically meaningful and changes can trigger validation errors. Done means the warning appears in an appropriate documentation location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100