typescript-eslint / typescript-eslint/examples
🛠️ Tooling: Add validation to README.mds that actual and expected outputs match
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 11
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
From https://github.com/typescript-eslint/typescript-eslint-examples/pull/4#discussion_r1485314117: right now, nothing validates that README.md files' content ("actual") include the output from their listed commands ("expected"). We should look into adding something in.
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 README.md files and the linked pull-request discussion. Determine how listed commands and their expected outputs are represented, then define validation that detects when actual content does not include the expected output. Done means mismatches are reliably reported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100