aws / aws/universal-test-runner
Add specific usage information/disclaimers to adapter READMEs
Open
- Dominant language
- TypeScript
- Stars
- 31
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Some adapter have weird usage limitation, such as the jest limitation discussed in https://github.com/aws/universal-test-runner/pull/162, we should add this information to their readmes
Contributor guide
Research direction
Start by locating the adapter README files and reviewing the Jest limitation discussed in pull request 162. Determine which adapters have usage restrictions, document those restrictions and disclaimers in the relevant READMEs, and verify that every affected adapter's usage information is covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100