oxidecomputer / oxidecomputer/progenitor
Document guidance regarding how to set the version of a generated crate
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1k
- Forks
- 136
- Avg merge
- 8h 36m
- Merged PRs (30d)
- 14
Description
Both the version from the OpenAPI document and the version of progenitor itself convey important information about compatibility. We should document an approach for how to assign a version number.
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
Review how the OpenAPI document version and the progenitor version are represented in generated crates. Determine where versioning guidance belongs and document an approach that explains compatibility implications. Done means the repository clearly explains how to assign a generated crate’s version number.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100