widgetti / widgetti/ipyreact

Add an `illustrative PR/issue` tag

Open
#16 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
134
Forks
9
PR merge metrics
No merged PRs in 30d

Description

There have been a bunch of small issues and pull requests here are very useful for future implementers, because they contain explanation of why things work as such. Ideally this would all be in documentation, until then, can we tag them with something like "illustrative PR".

There is a lot of context necessary for someone to use ipyreact, and it is going to be rare for someone to understand all of the following

  • Traitlets quirks (only assignment - not updates to a dict, change must be present)
  • React only assignment not updates to a dict
  • Where JS errors show up in the jupyter notebook

https://github.com/widgetti/ipyreact/pull/14
https://github.com/widgetti/ipyreact/pull/11
https://github.com/widgetti/ipyreact/issues/6

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the examples linked in PRs 14 and 11 and issue 6 to identify the illustrative items. Create an "illustrative PR/issue" tag and apply it to the relevant issues and pull requests; done means those examples are consistently labeled for future implementers.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, react
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.