MarcelGarus / MarcelGarus/repository

Lack of documentation and working example code on pub is an issue

Open
#4 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dart
Stars
14
Forks
0
PR merge metrics
No merged PRs in 30d

Description

I was intrigued by the prospect of a repo library. However, looking through pub pages and the Github repo I found the lack of a few examples, and documentation to be very limiting. It's not that developers can't spend time reading and grokking your code, but who has time to dig that deep when trying to decide if a library is worth using. I suspect your library gets passed over because of this lack of information. Also, if it doesn't already, the library should be able to handle gathering data from two sources easily. Anything above your library shouldn't need to know if the data came from a cache or an API call. The repo should handle this. I think your library would be much more popular if you documented it with good documentation and provided multiple code samples so devs can see how to use it and how it would be helpful without taking the time to dig into the details of how it works. I hope this helps and gives you a little motivation to continue developing this and other Flutter libraries.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the pub page and GitHub repository first to identify the library's current usage and data-source behavior. Define which documentation, working examples, and cache/API abstraction are actually needed, then consider the issue complete when newcomers can understand the library's value and follow examples without reading its implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart, flutter
Domain
backend, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.