rollbar / rollbar/rollbar-react
<RollbarContext /> implementation doesn't match docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 46
- Forks
- 9
- Avg merge
- 2d 56m
- Merged PRs (30d)
- 4
Description
Docs: https://docs.rollbar.com/docs/react#rollbarcontext-component
1 - RollbarContext requires the onRender prop
Calling
<RollbarContext context="home">…</RollbarContext>
doesn't actually set Rollbar's context to 'home'. On further examination of the RollbarContext component, I saw I needed to add a onRender prop for it to work:
<RollbarContext context="home" onRender>…</RollbarContext>
This doesn't align with the docs linked above.
2 - RollbarContext type is incorrect
Given the requirement of the onRender prop, RollbarContext's type is incomplete.
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 with src/rollbar-context.js and the RollbarContext type in index.d.ts at the linked line, then compare both with the React documentation linked in the issue. Confirm the expected behavior for the shown usage and update the implementation, type, and documentation so they agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react, typescript
- Domain
- documentation, frontend, observability
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100