DavidWells / DavidWells/analytics
Improving TypeScript Support
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2.7k
- Forks
- 267
- PR merge metrics
- No merged PRs in 30d
Description
I'm loving this package, but the TypeScript types generation is very complicated. Is there a guide on how to contribute types? I understand that the core idea is that the types are generated from JSDoc.
I was hoping to add types for analytics-utils as I am developing a new plugin in TypeScript, however I'm a bit lost as to how that should be done.
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 tracing how the repository generates TypeScript types from JSDoc, with particular attention to analytics-utils. Document the contribution workflow and explain how types for analytics-utils can be added; done means a newcomer can follow the guide to contribute those types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100