oxidecomputer / oxidecomputer/oxide.ts

Need proper versioning scheme for `@oxide/api`

Open
#245 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
33
Forks
4
Avg merge
6d 9h
Merged PRs (30d)
4

Description

Followup to #240. Probably follow https://github.com/oxidecomputer/oxide.rs. Ideally we are indicating what Omicron commit the API schema came from.

Versioning scheme for generator probably doesn’t matter much, just say what we’re doing in the README.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading follow-up issue #240, the linked oxide.rs repository, and the @oxide/api README. Define a versioning scheme that indicates which Omicron commit the API schema came from, and document the generator-versioning decision and resulting process in the README.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.