microsoft / microsoft/CLRInstrumentationEngine
Document the interfaces used/provided by CLRIE
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C++
- Stars
- 102
- Forks
- 52
- Avg merge
- 13h 11m
- Merged PRs (30d)
- 6
Description
Sometimes finding/reading the IDL file can be difficult. It may be easier to list all of the interfaces in a docs markdown (user-friendly)
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 locating the CLRIE IDL file and any existing documentation markdown. Compare the interfaces defined or provided there, then document the complete interface list in a user-friendly markdown page. Done means the documentation makes the interfaces easier to find and read.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100