[DOCUMENTATION] JSDocs Linting - Githubissues

BroncoDirectMe / Backend

BroncoDirectMe's API for the Chrome Extension

https://broncodirect.me

9 stars 1 forks source link

[DOCUMENTATION] JSDocs Linting #32

Closed GuyWhoCode closed 1 year ago

GuyWhoCode commented 1 year ago

User Story

As a developer, I want to see information about a function when hovering over the function name by making all other developers write JSDocs.

Technical Tasks

Add an ESLint rule to enforce JSDocs implementation. See this link and this link as a starting place.

Acceptance Criteria

ESLint will display a warning or error if JSDocs is not implemented at all or correctly.