oxidecomputer / oxidecomputer/omicron
Make descriptions optional
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
On the console we're initialising description as "" so it doesn't make much of a difference, but as it is you do need --description "" on the CLI and API. Would be a better UX to not require it.
Contributor guide
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 tracing how the CLI and API require the description field, comparing that behavior with the console's empty-string initialization. Confirm the expected behavior for omitted descriptions in both interfaces, then add coverage showing that the CLI and API accept requests without --description or an equivalent field.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100