Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding information about Flutter and the utility #24

Merged
merged 4 commits into from
Feb 9, 2020

Conversation

miguelmartins17
Copy link
Collaborator

I've added some topics like why you should use/learn Flutter , the core principles and how widgets work.
I hope it helps and that it can improve the repository. 👍

README.md Outdated

![Screen Shot 2020-02-06 at 19 01 17](https://user-images.githubusercontent.com/27420533/73969408-4475d280-4913-11ea-8384-99c863321155.png)

Widgets are themselves often composed of many small, single-purpose widgets that combine to produce powerful effects.</br>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miguelmartins17 please do not copy-paste directly from the Flutter docs.
google search
image
What you have added here is identical to the Flutter Technical overview
https://flutter.dev/docs/resources/technical-overview
image
Maybe your teachers did not care about students copy-pasting large blocks of text but we do.

  1. it does not show that you have learned/understood the concepts; it just shows you are being lazy.
  2. You should be learning how to synthesize (or "summarise" if you prefer) other people's writing.
  3. https://en.wikipedia.org/wiki/Plagiarism

Please re-write this in your own words or simply link to the official docs given that they include images and have been written by professional technical writers.

@miguelmartins17
Copy link
Collaborator Author

@nelsonic When you have time please if you can review this 👍

@nelsonic
Copy link
Member

nelsonic commented Feb 8, 2020

@miguelmartins17 when you feel you have finished working on the PR, please assign it to me and update the label from in-progress to awaiting-review.
See: https://github.com/dwyl/contributing#step-3-prepare-a-pull-request-pr-and-assign-to-someone-else-for-review

@nelsonic
Copy link
Member

nelsonic commented Feb 8, 2020

@miguelmartins17 the PR is still assigned to you ...
image

The reason we update the assignee is so that it's clear who's "turn" it is.
In the past we have had instances where reviewer is reviewing the code and the author pushes up a change that invalidates the reviewer's efforts which is a huge waste of time.
That's review only starts when the PR is assigned to the reviewer.

@nelsonic
Copy link
Member

nelsonic commented Feb 8, 2020

To be clear: the reason I left a comment on the PR yesterday before it was assigned to me for review. Was that I wanted to help you avoid copy-pasting directly from the Flutter docs.
Copy-pasting is the equivalent of you ordering a takeaway from PizzaHut and saying you "cooked" it. 🙄

@miguelmartins17
Copy link
Collaborator Author

@nelsonic So is it necessary to change the Assignees for you ? 😕

@nelsonic
Copy link
Member

nelsonic commented Feb 8, 2020

Miguel, if you it's too much effort for you to follow a systematic approach, please let me know. 👍
Everyone else accepts that our workflow is to assign a Pull Request. Are you special?

@miguelmartins17
Copy link
Collaborator Author

@nelsonic Of course, I didn't even say anything like that, I just didn't understand if you're supposed to be Assignee.

@miguelmartins17
Copy link
Collaborator Author

@nelsonic In case you didn't realize my approach was in a tone of doubt not in a tone of thinking it is a strange method.

@nelsonic
Copy link
Member

nelsonic commented Feb 8, 2020

Miguel, what you're saying is that you didn't read the instructions or link I shared above. #24 (comment) ⬆️
image

read-the-contributing-guide

Reading the contributing guide is a requirement ... https://github.com/dwyl/apprenticeship#prerequisites
apprenticeship-prerequisites

I'm not trying to be difficult, I just want you to understand that every company/organisation has a "workflow" for getting work done. Most software companies are a lot more tedious than ours. 👍

@miguelmartins17
Copy link
Collaborator Author

@nelsonic I read it now and I understand what you mean.
I thought as a reviewer it was right for you to do the Pull Request review.

Obviously I wasn't going to merge the text I was trying to add without someone doing the review first, I already had wrong before.
I'm sorry.
I understand your very methodical workflow that it's right to be like this since you have to follow everything closely so there are no mistakes. 😄

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
- Flutter can be used to build applications for Android and IOS
- The Dart language used in Flutter is quite similar to Java
- We can update the application in real time
- If we close the application when we open it again we can continue from where we were
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This benefit is not exclusive to Flutter development and it's unclear what this means.
Are you saying that you can pickup your work in the IDE or When you re-open the test app on the device?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was talking about getting us back to where we were at the IDE.

But it probably wasn't the best advantage of using Flutter.
There is also the "Hot reload" advantage that allows the developer to see changes made only to what was modified without having to run the application from the beginning again.
Flutter reloads only the screen that was changed and faster.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All modern IDEs have this feature so that people don't lose their work when the IDE or OS crashes.
Try opening a Phoenix project in Atom. Open a bunch of files in several tabs.
Quit the Atom and re-open it. You'll see that the active tab will still be active when you re-open the app.

Hot reloading is a major benefit of Dart/Flutter. 👍

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Widgets form a hierarchy whenever we use one of them we will have another that will complement it.</br>
There are widgets that are used in all applications and some that are used in specific situations.</br>

![Screen Shot 2020-02-06 at 19 01 17](https://user-images.githubusercontent.com/27420533/73969408-4475d280-4913-11ea-8384-99c863321155.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good image showing the hierarchy of widgets. Did you create the diagram?
If you didn't create it from scratch, please attribute it to the source where you got it.

e.g: this gif explains the Flutter widget hierarchy visually:
flutter-widgets-gif
See: https://dev.to/rubensdemelo/flutter-widget-tree-and-state-management-31an

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow is a really good and different illustration of how Flutter works.
Super interesting a diagram like this. 🆒 😃

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
The Flutter is formed by several layers that are each layer and built one on top of the other.


![Screen Shot 2020-02-07 at 09 06 06](https://user-images.githubusercontent.com/27420533/74015797-36629900-4989-11ea-8ec1-757aecad18ce.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another good image, but it looks familiar ... https://www.zup.com.br/blog/flutter
Please attribute the source of images when you "borrow" them from someone else's blog post. 💭

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@nelsonic nelsonic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miguelmartins17 this is a good addition. 👍
I have made a few suggestions. The review process is meant to be a learning experience.
Please read through my comments & suggestions and reply to them.
Click the "Add suggestion to batch":
image
Once you've added all the suggestions, you can commit them to the branch.

Once you have finished replying to my comments/suggestions,
please (re)assign the PR back to me for final review & merge.
Thanks. 👍

@miguelmartins17
Copy link
Collaborator Author

@nelsonic Where should I click now ?

Screen Shot 2020-02-09 at 14 10 59

Co-Authored-By: Nelson <contact.nelsonic+github@gmail.com>
@nelsonic
Copy link
Member

nelsonic commented Feb 9, 2020

@miguelmartins17 what are the options when you click on "Review changes"?

Copy link
Member

@nelsonic nelsonic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miguelmartins17 thanks for replying to my review comments and accepting my suggestions. 👍

@nelsonic nelsonic merged commit 985f624 into master Feb 9, 2020
@nelsonic nelsonic deleted the miguelmartins17-patch-1 branch February 9, 2020 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants