oxidecomputer / oxidecomputer/omicron
blueprints missing comments
Open
Nobody has claimed this yet.
Good for new hires
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
Following up on #10392, the following blueprints mentioned in that issue are missing comments:
6642d96e-8f0b-4bb2-9332-3c36d1ad0905(inserted initial R18 measurements)a2dbbfc0-fba7-4164-98ca-f4106887dfa2(part of MUPdate resolution)
This made it harder to skim the history and understand what these blueprints were doing.
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
Read issue #10392 for the context of the two blueprints, then search the repository for IDs 6642d96e-8f0b-4bb2-9332-3c36d1ad0905 and a2dbbfc0-fba7-4164-98ca-f4106887dfa2. Add comments that explain the initial R18 measurements and the MUPdate resolution, and confirm both blueprints are easier to understand when scanning their history.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100