microsoft / microsoft/vscode-edge-devtools

Outdated TSLint recommendation in CONTRIBUTING.md

Open
#2,807 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
827
Forks
358
Avg merge
20h 32m
Merged PRs (30d)
10

Description

Description

The CONTRIBUTING.md file for the Microsoft Edge Tools for VS Code extension recommends using TSLint. However, TSLint has been deprecated in favor of ESLint. The documentation should be updated to reflect this change.

Steps to Reproduce
  1. Go to the CONTRIBUTING.md file in the repository.
  2. Notice the recommendation to use TSLint.
Expected Behavior

The documentation should recommend using ESLint instead of TSLint.

Environment
  • Extension Version: 2.1.8
  • VS Code Version: 1.97.2 (user setup)
  • Operating System: Windows 11 Business, Version 24H2, OS build 26120.3291
Additional Context

ESLint is now the recommended linter for TypeScript projects. More information on migrating from TSLint to ESLint can be found here.

Contributor guide

Open the contributing guide

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

Open CONTRIBUTING.md and locate the recommendation to use TSLint. Update that documentation to recommend ESLint instead, then review the surrounding text and the linked migration guidance to confirm the wording is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.