trivago/melody

Missing IntelliSense on VS Code.. Add Type Definitions and JS Doc

Open

#7 opened on Nov 24, 2017

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)JavaScript (37 forks)auto 404
good first issue

Repository metrics

Stars
 (216 stars)
PR merge metrics
 (PR metrics pending)

Description

IntelliSense for melody is really hard to read in Visual Studio Code. VS Code generates this from JS Doc or Type Definition files.

Sadly, there are only very few places in melody that have JS Doc comments. For some reason, a lot of functions have a license header instead of actual documentation. Why do you write license header for every function instead of just once per file?

Those few parts that have JS Doc don't seem to show in IntelliSense either.. I guess VS Code can't make it work for node-modules. But Type Definition files do work and they even work for JavaScript, so your users don't need to use TypeScript to benefit from this.

A website with tutorials is of course a nice starting point, but when I code, I usually use IntelliSense instead of visiting a website.

Contributor guide

Research direction
Explore the melody codebase to identify functions missing JSDoc comments and type definitions, then add them following existing patterns.
Tech stack
javascript
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptJSDoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80