dart-lang / dart-lang/pub-dev

Examples requirement unnecessary for small packages

Open
#2,931 2 comments 0 reactions 0 assignees View on GitHub
Type: enhancement
Dominant language
Dart
Stars
944
Forks
184
Avg merge
1d 15h
Merged PRs (30d)
12

Description

We maintain a small package called fluri (https://pub.dev/packages/fluri) that is currently being docked 10 points for not maintaining an example in the `example/` directory. This package's functionality is very small and for that reason, we've included usage examples directly in the readme. In fact, at this point, the description + examples make up the entirety of the readme.

It seems unnecessary to me that we would have to either duplicate or move the examples to the `example/` dir just to get those 10 points back, and I would argue that the readme is a better place for that information in this case since it is immediately accessible and explains the purpose of the package at the same time.

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.