Skip to content
This repository was archived by the owner on Nov 20, 2024. It is now read-only.

add Flutter doc guidance to clarify $user in flutter_style_todos #2232

Merged
merged 1 commit into from
Sep 3, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/src/rules/flutter_style_todos.dart
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ const _details = r'''

**DO** Use Flutter TODO format.

From the [Flutter docs](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#comments):

> TODOs should include the string TODO in all caps, followed by the GitHub username of the person with the best context about the problem referenced by the TODO in parenthesis. A TODO is not a commitment that the person referenced will fix the problem, it is intended to be the person with enough context to explain the problem. Thus, when you create a TODO, it is almost always your username that is given.

**GOOD:**
```
// TODO(username): message.
Expand Down