microsoft / microsoft/TypeScript
Provide documentation on writing fourslash tests
Open
Nobody has claimed this yet.
Docs
Infrastructure
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
You know what fourslash needs? Extensive documentation/comments on how fourslash works and the fourslash API. Half the time I can never figure out what I need to call to test something and have to dig through other tests to figure out when to use
/**/or[| |], etc.
— @rbuckton
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
No files, tests, or entry points are named. Start by locating the fourslash implementation, API, and existing tests; document how fourslash works, including when to use /**/ and [| |], with completion reflected in the relevant project documentation or comments.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100