andre-paraense / launchdarkly_flutter

A LaunchDarkly Flutter SDK
GNU Lesser General Public License v3.0
4 stars 5 forks source link

Package maintenance #3

Closed andre-paraense closed 4 years ago

andre-paraense commented 4 years ago

Requirements

Related issues

No issues related to this one. We have just followed the package maintenance tips given by Pub Dev, which were:

Health issues and suggestions

Document public APIs. (-1 points) 6 out of 6 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API. Format lib/launchdarkly_flutter.dart. Run flutter format to format lib/launchdarkly_flutter.dart. Maintenance suggestions

The package description is too short. (-20 points) Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Describe the solution you've provided

Literally just did what they asked for. In the process of making it, discovered we were forcing the user to pass user's email as an obligation, which was wrong, so for the moment we took it out. Should come back again as an optional attribute, along with others.

How to test?

Run the example app.

Future works

Nothing in this direction for now, just keep monitoring packages health and maintenance! ;)