rokucommunity / rokucommunity/brighterscript
Document how to add type definitions to codebases
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 208
- Forks
- 68
- Avg merge
- 8h 39m
- Merged PRs (30d)
- 39
Description
We need to document how to actually add type definitions to code bases. As people adopt this, we'll probably have many people wondering: should I add interface declarations to the top of the file? A separate file with the same name (like a .d.bs file)
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
No documentation file or test is named in the issue. Start by locating the project's existing type-definition documentation and examples, then cover the placement and file-convention questions raised here, including interface declarations and separate .d.bs files. Done means a newcomer can follow the guide to add type definitions to a codebase.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100