lethalbit / lethalbit/Slice-N-Splice
Better object file API documentation
Open
Nobody has claimed this yet.
COFF
documentation
ELF
good first issue
Mach-O
PE
- Dominant language
- C++
- Stars
- 6
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Document the objects and values within the object file APIs to be actually usable. It's currently just a mishmash of comments about obvious things followed but magic values or arcane names.
Contributor guide
No contributing guide indexed for this repository
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 locating the object file APIs and reviewing their existing comments, then inventory the objects, values, magic values, and arcane names that need explanation. Done means the documented APIs are usable without relying on obvious comments or unexplained names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100