You are viewing a single comment's thread from:

RE: Flutter Diamond Floating Action Button Library

in #utopian-io7 years ago

Thanks for the contribution!

Seems like a useful bit of code. A few things to keep in mind for future contributions:

  • It would be great if you could improve the quality of your commit messages. There are a lot that are simply "Add files via upload" or ones with identical messages.

  • Improving your usage and install instructions in the README, which is currently just "Add this to your package's pubspec.yaml file". I know you have linked a video above (which didn't work at the time of reviewing), so it would also cool if you'd add that to the README as well.

  • The comments you added are very descriptive, but I'm not sure that much is needed to describe a single variable each time.

Looking forward to see if you can get this integrated into the official Flutter SDK!

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

Sort:  

Thank you for reviewing my contribution and thank you for the constructive criticism I will keep that in mind for the next time that I release a development contribution. Here are a few things to note;

I am not really sure how a YouTube video could be unavailable when it just an unlisted video on my channel. I checked it multiple times myself (logging out and all of that) and it seemed to work fine, even checked the listing to make sure that I had listed it as "unlisted" and not "private" and it was indeed posted as unlisted.

I agree about the commit comments and won't say much more on the topic.

The comments in the code are specifically verbose because when you hover over a widget inside of a IDE or editor, it actually shows you these comments. Generally, you want to also have comments for each little field/property of the widget because again, the user can hover over the property and get a small description of what it does etc. This is an idiom in the Dart community and I was just following it.

As far as the readme goes, the reason the installation instructions are so bare bones is because typically these are left completely out of a readme for a dart/flutter package. This is because the package is hosted on this platform here and the pub platform auto generates this kind of information for you.

Here is the page that is connected to this library. If you do take the time to look, you will see that they generate a lot of things from the comments, changelog and example. Now, that being said, I knew full well that you or whomever read this was most likely not a part of the dart community so you would be unlikely to look on pub.dartlang.org for my package's information. As such I should have made the readme much more verbose just for this post.

Anyhow, I will keep all of this in mind the next time I contribute to development. To be honest, I wasn't even sure I should post this library and your score more or less confirms what I believed.

Coin Marketplace

STEEM 0.13
TRX 0.34
JST 0.034
BTC 113638.48
ETH 4343.45
SBD 0.86