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

Update bdd flutter blog #147

Merged
merged 7 commits into from
Jul 9, 2024
Merged

Update bdd flutter blog #147

merged 7 commits into from
Jul 9, 2024

Conversation

grgprarup
Copy link
Contributor

This PR updates the BDD with Flutter blog according to the latest version of the Flutter framework. Also, some broken links are fixed.

@grgprarup grgprarup requested review from individual-it and a team June 25, 2024 10:41
@grgprarup grgprarup self-assigned this Jun 25, 2024
Copy link
Contributor

@koebel koebel left a comment

Choose a reason for hiding this comment

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

Here are some points, mainly related to English language and grammar, readability and understandability, that I noticed when reading through the blog. Github didn’t allow me to comment directly on lines where no content changes were made. Therefore I list them here with reference to the corresponding line where appropriate.

  • App is sometimes spelled with capital letter and sometimes with small letter. I think it’s more common to spell it with small letter. Please make the spelling consistent.
  • For the the flutter link in line 15, the current link lands on a page where the types of testing are mentioned as a bullet but no further information is shared. I think this page would be more helpful for the reader: https://docs.flutter.dev/testing/overview
  • In line 18 there is the first mention of Cucumber. Up to that point only Gherkin was mentioned. I think this could be a bit confusing to the reader. Also adding a link to Gherkin Documentation/Reference at the first instance Gherkin is mentioned (line 13) would from my point of view add some value to those readers who are not that familiar with Gherkin. You could for example link to this page: https://cucumber.io/docs/gherkin/reference/
  • Since the abbreviation BDD was introduced in the first sentence (line 13), there is no need to repeat “BDD (Behavior Driven Development)” throughout the text. Just use “BDD” or “Behavior Driven Development” at later instances, but not both
  • Line 28: Currently the flow of text doesn’t look nice. It would be more readable if you add a proper link like this:
“But enough theory, let’s get our hands dirty.
_Note: You can find all the code of this tutorial here_”
  • Title on line 30: either “The feature file” (singular) or “Feature files” (no article)
  • Line 76: This is no proper sentence… You could for example change it to this
“After adding, run flutter pub get.” 
or add this sentence fragment to the previous sentence in line 68
  • Line break in line 150 breaks the flow. I think the stand alone line 151 can be added to the paragraph above
  • Adding code snippet of main.dart after line 161 might be helpful for the reader
  • Some sentences are quite long. For readability it would be easier to break them into shorter sentences. Additionally, it is more common to use points or depending on context double points for this. Semicolon like in line 45 is rather uncommon.
  • In English language there should be a point at the end of each full sentence (e.g. line 32). And also using commas at the right places helps with readability :)
  • Plus sentences usually start with capital letters (e.g. line 177)

src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Show resolved Hide resolved
@koebel
Copy link
Contributor

koebel commented Jul 3, 2024

The improvement suggestions above related to writing style and understandability will be addressed in #150

@grgprarup grgprarup requested a review from koebel July 3, 2024 12:20
Copy link
Contributor

@koebel koebel left a comment

Choose a reason for hiding this comment

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

Thanks for even addressing some of the points of #150 :)

Content wise, adding code snippet of main.dart after line 161 might be helpful for the reader

And what concerns readability, some sentences are still very long... (Github doesn't allow me to comment on certain sections of the blog...)

  • suggestion for line 60: "Later we will add more scenarios to the app. The feature might be the same, but in different scenarios it might have to react differently."
  • suggestion for line 115 (also check grammar in this sentence): "That was all we needed to do for the installation. Now we have to tell the test-software what actually to do with our Given, When and Then steps." or "That is all we need to do for the installation. Now we have to tell the test-software what actually to do with our Given, When and Then steps."
  • the following sentences in line 116 and 117 would be clearer if commas where used n the right places :)
  • I think line 163 belongs together with the line above. The line break breaks the flow of reading... suggestion: "...widget. Alternatively, you could also use find.byTooltip, find.Type or find.bySemanticsLabel." (without line break before )
  • Another thing are titles: some of the titles are written using the all capital style, others don’t even use capital for the first word of the title… it would be nicer to use the same writing style for all titles (can maybe be addressed in improvement suggestions for BDD Flutter blog #150)

src/assets/BDDWithFlutter/BDDWithFlutter.md Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
@grgprarup grgprarup requested a review from koebel July 8, 2024 05:43
@grgprarup grgprarup force-pushed the update-bdd-flutter-blog branch 2 times, most recently from ee3ba8f to 1314221 Compare July 8, 2024 06:20
@grgprarup
Copy link
Contributor Author

The PR #152 needs to be merged before this.

Copy link
Member

@phil-davis phil-davis left a comment

Choose a reason for hiding this comment

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

Sorry, we seem to be reviewing all the English in the original post, not just doing the minimum to make it work again.

src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
src/assets/BDDWithFlutter/BDDWithFlutter.md Outdated Show resolved Hide resolved
@grgprarup grgprarup requested a review from phil-davis July 9, 2024 03:47
@phil-davis
Copy link
Member

@koebel please review.

IMO the point of this PR was to get this blog as close as possible to working with "modern" Flutter etc. versions. But we also ended up reviewing English grammar that had been there for years. I think that we should merge what we have now, otherwise it will go on forever.

@koebel
Copy link
Contributor

koebel commented Jul 9, 2024

@koebel please review.

IMO the point of this PR was to get this blog as close as possible to working with "modern" Flutter etc. versions. But we also ended up reviewing English grammar that had been there for years. I think that we should merge what we have now, otherwise it will go on forever.

that's completely fine with me. For this reason we originally suggested to do the changes in two different PRs - see #150

I'll add the open points for discussion into the other issue.

Copy link
Contributor

@koebel koebel left a comment

Choose a reason for hiding this comment

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

LGTM, remaining questions regarding clarity, readability and writing style can be addressed later in #150

@grgprarup grgprarup merged commit d71c807 into master Jul 9, 2024
1 check passed
@grgprarup grgprarup deleted the update-bdd-flutter-blog branch July 9, 2024 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants