microsoft / microsoft/DefinitelyTyped-tools

Missing .md explanation of 'expect' rule?

Open
#860 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
423
Forks
237
Avg merge
18h 18m
Merged PRs (30d)
11

Description

Following up on #843: is there a single good .md file we can look at for reference for the @definitelytyped/expect lint rule? I think it got missed in https://github.com/microsoft/DefinitelyTyped-tools/tree/42484ff245f6f18018de729f12c9a28436daa08a/packages/eslint-plugin/docs/rules.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in packages/eslint-plugin/docs/rules at the referenced commit and compare the existing rule documentation files. Add the missing .md explanation for the @definitelytyped/expect rule, using the related issue #843 for context. Done means the rule has a clear reference page alongside the other rules.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.