Open Bug 1461976 Opened 7 years ago Updated 3 years ago

Create a linter for comment style in the Telemetry component

Categories

(Toolkit :: Telemetry, enhancement, P3)

Product:
Toolkit
Component:
Telemetry
Type:
enhancement

Tracking

()

Tracking Flags:
Tracking Status
firefox62 --- affected

People

(Reporter: Dexter, Unassigned)

References

(Blocks 1 open bug)

Details

Different parts of the Telemetry code have different comment style and syntaxes: sometimes addressing the user with `we`, sometimes more formal passive phrasing. Moreover, while it's not mandated, the de facto commenting standard of our codebase is jsdoc, so we should make sure to comply to it. This bug is about investigating the creation of linter rules to address the above points.
Blocks: 1201022
Priority: -- → P3
Severity: normal → S3
You need to log in before you can comment on or make changes to this bug.