WebAssembly / WebAssembly/wabt
Add checklist for new instructions
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 8.1k
- Forks
- 827
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 18
Description
@aardappel mentioned that it would be nice to have a checklist when adding a new instruction; there are a lot of places that you need to change, and it's easy to miss some.
The compiler will catch a number of them, since adding a new enum to the opcodes list will create a warning, but there are some that only get flushed out with a new test.
It may be instructive to look at the distinction between the bulk-memory-operation change here, and the one that landed afterward here.
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
Compare the two linked bulk-memory-operation commits to identify every place that changed when adding an instruction, including changes only exposed by tests. Use that comparison to draft a checklist covering those locations and validation steps. Done means the checklist makes the required instruction-addition work explicit and helps prevent omissions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100