Document saved state compatibility guarantees and process
Open
Nobody has claimed this yet.
bug
documentation
- Dominant language
- Rust
- Stars
- 1.9k
- Forks
- 238
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 100
Description
- Document forward/backward guarantees
- Document protobuf-based analysis tools for determining what has changed between builds
- Document release process:
- Use the tools
- After the fork, delete fallback/fixup code for releases that are no longer supported.
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 by locating the existing documentation for saved-state compatibility, protobuf-based analysis tools, and the release process in the OpenVMM repository. Done means documenting forward and backward guarantees, how to determine changes between builds, and the release steps for using the tools and removing obsolete fallback or fixup code.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100