oxidecomputer / oxidecomputer/omicron
linter requests for summary
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
For example:
- No punctuation, there is a comma, I'm already trimming all the periods off but if you want to parse for that would be nice as well.
- This should just be "Migrate an instance" like three words the rest can be in the description
- Can we cap the amount of characters to <20 or 25 even.
- Some summaries are still missing for example https://docs.oxide.computer/api/instance_disks_attach so some sort of error on that
cc @ahl if you think this is possible
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 with the API summary linter and compare the examples at the migrate-an-instance and instance_disks_attach documentation URLs. Confirm how summaries are produced and reported, then verify that punctuation, length, concise wording, and missing-summary cases meet the requested behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100