google / google/grinder.dart

Improve documentation

Open
#305 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Dart
Stars
266
Forks
36
Avg merge
23h 25m
Merged PRs (30d)
2

Description

It is very hard now to understand how to use this tool.
It would be great, if you add some HOW-TOs, examples, typical scenarios and so on.

e.g I fund out that I can't define tasks in camelCase like that:

```
@Task()
someTask() => ...
...
> grind someTask
Error, no task found: 'someTask'.
```

but that works fine:

```
@Task()
sometask() => ...
...
> grind sometask
OK
```

And that is just a simple case that lies on the surface.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.