First steps and planning
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 23
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
@hoodmane @rth @ryanking13
These are the first steps where I could focus my energies for now:
- Copy the source code of the generator in this repo (the linked repository contains more than that, so I will not bring in the history of everything there. Just that folder in the current state.
- Organize the project with the
srclayout. - Run the tests of the generator on every push through GitHub Actions
- Write some documentation
- Create some script/automation to generate the js.pyi artifact and push it to pypi
- Bring in the existing open issues from the other repo
- Plan something to join manual webidls (sadly I noticed that no one webidl source is enough...) now the best webidl source I know is from w3c/webref/curated
And then these points are for adding comments to the api:
- Investigate how to gather the information about api platform availability (probably from the webidl files)
- Gather/harvest comments from MDN (maybe there is some structured information about the previous point?)
What do you think?
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 reviewing the js_pyi generator source and the proposed src layout. Then inspect how its tests can run through GitHub Actions on every push, and how the generated js.pyi artifact could be published to PyPI. The issue lists documentation, imported issues, WebIDL sources, and MDN comments as additional planning areas, so completion is not narrowly defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- build-system, ci-cd, documentation, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100