microsoft / microsoft/CLRInstrumentationEngine
Impress upon readers the importance of the CreateBaseline API
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 102
- Forks
- 52
- Avg merge
- 13h 11m
- Merged PRs (30d)
- 6
Description
In the introductory pages: Getting Started, Design Notes, and any other ancillary docs there is no mention whatsoever of the CreateBaseline API. This API is mentioned in passing here.
It is extremely important to make implementors aware of it early on in the intro pages, otherwise they may be flying blind, making it difficult to estimate time and effort required.
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 docs/getting_started.md and DESIGN-NOTES.md, then inspect the CreateBaseline API reference at src/InstrumentationEngine.Api/InstrumentationEngine.idl near line 277. Update the introductory and relevant ancillary documentation so implementors encounter the API and understand its importance early; done means the requested references and context are present.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100