Skip to content

Fix grammar and improve phrasing in README#13106

Merged
sfshaza2 merged 3 commits intoflutter:mainfrom
Vonarian:patch/Readme
Feb 23, 2026
Merged

Fix grammar and improve phrasing in README#13106
sfshaza2 merged 3 commits intoflutter:mainfrom
Vonarian:patch/Readme

Conversation

@Vonarian
Copy link
Copy Markdown
Contributor

Description of what this PR is changing or adding, and why:

Correct grammar and phrasing in README.md.
Issues fixed by this PR (if any):
Multiple (but small) changes were made to the README file to make it slightly more formal and also fix typos, grammar issues and similar.
PRs or commits this PR depends on (if any):
N/A

Presubmit checklist

  • If you are unwilling, or unable, to sign the CLA, even for a tiny, one-word PR, please file an issue instead of a PR.
  • If this PR is not meant to land until a future stable release, mark it as draft with an explanation.
  • This PR follows the Google Developer Documentation Style Guidelines—for example, it doesn't use i.e. or e.g., and it avoids I and we (first-person pronouns).
  • This PR uses semantic line breaks
    of 80 characters or fewer.

Correct grammar and phrasing in README.md.
@Vonarian Vonarian requested review from a team and sfshaza2 as code owners February 23, 2026 11:00
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @Vonarian, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the readability and professionalism of the README.md file by addressing numerous grammatical inaccuracies, awkward phrasing, and minor typos. The changes aim to provide a clearer, more formal, and consistent guide for contributors and users, aligning the documentation with established style guidelines and improving the overall user experience.

Highlights

  • Grammar and Phrasing Improvements: Corrected various grammatical errors, pronoun usage, and improved overall phrasing for better clarity and formality throughout the README.md file.
  • Adherence to Style Guidelines: Ensured consistent terminology and alignment with the Google Developer Documentation Style Guidelines, including specific examples like avoiding 'i.e.' or 'e.g.' and using direct language.
  • Enhanced Instructional Clarity: Refined instructions for PR submission, site building, and verification steps, making them more direct, polite, and easier to understand for contributors.
  • Updated Error Message Wording: Adjusted the tense of a specific build error message related to code excerpts for accuracy.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • README.md
    • Updated pronoun usage from 'those issues' to 'them' and 'handles those' to 'handles them' for better flow.
    • Changed 'But here are a few notes' to 'Here are a few things' and 'But we welcome PRs' to 'However, we welcome PRs' for improved formality.
    • Refined the description of Grammarly from '(or similar)' to '(or a similar tool)'.
    • Adjusted the phrasing of style guide examples for conciseness (e.g., 'avoid "i.e." or "e.g."' instead of 'don't use "i.e." or "e.g."').
    • Changed 'do consider building' to 'please build and test' for a more direct and polite instruction.
    • Corrected preposition usage from 'it's on your path' to 'it's in your path' and improved verb agreement for Flutter version status.
    • Ensured singular agreement for 'version of Flutter' when referring to setup prerequisites.
    • Improved sentence structure for verifying code changes, including adding 'and then run' and 'that it is up to date'.
    • Simplified error handling instructions from 'then address those issues' to 'address them' and 'we'll try our best to help you' to 'we'll do our best to help'.
    • Clarified the conditions for checking links, changing 'would like to check all internal links are functional and Markdown link references are valid, build the site locally and then run' to 'want to check that all internal links and Markdown link references are valid, build the site locally and run'.
    • Replaced 'Validate all internal links are valid' with 'Verify that all internal links are valid' for consistency.
    • Updated the tense in the code excerpt error message from 'needed to be updated!' to 'need to be updated!'.
Activity
  • No specific activity (comments, reviews, or progress updates) was provided for this pull request.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces several grammatical and phrasing improvements to the README.md file, enhancing its clarity and formality. The changes are generally positive, such as replacing 'But' with 'However', using more direct language like 'please' instead of 'do consider', and making sentences more concise. I've added one suggestion to improve the consistency of a list of style guidelines.

Comment thread README.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@sfshaza2
Copy link
Copy Markdown
Contributor

/gcbrun

Copy link
Copy Markdown
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

Sure.

@flutter-website-bot
Copy link
Copy Markdown
Collaborator

Visit the preview URL for this PR (updated for commit aa43802):

https://flutter-docs-prod--pr13106-patch-readme-oo39r4d0.web.app

@sfshaza2 sfshaza2 merged commit 8b5a0f0 into flutter:main Feb 23, 2026
10 checks passed
@Vonarian Vonarian deleted the patch/Readme branch February 24, 2026 06:27
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