microsoft / microsoft/TypeScript-Sublime-Plugin

The README is not formatted properly on the Package Control site

Open
#626 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.7k
Forks
236
Avg merge
21d 13h
Merged PRs (30d)
1

Description

https://packagecontrol.io/packages/TypeScript

screen shot 2017-10-16 at 12 36 49

In particular, the git clone command is missing a -, if anyone tries to copy and paste it, it will not work. However it looks fine here on GitHub.

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

Open the linked TypeScript package page and inspect the repository README and its rendered Package Control output, focusing on the git clone command shown in the screenshot. Correct the missing hyphen in the README, then verify that the command renders correctly and can be copied from the Package Control page.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.