Skip to content

Update README.md - grammar and writing fixes #8084

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

oddlittlebird
Copy link

@oddlittlebird oddlittlebird commented Jun 26, 2025

Feature Preview

This PR makes minor improvements to the README, including:

  • Make headings consistently sentence case. They were previously some title case and some sentence case.
  • Replaced vague link text such as "here" with specific link text.
  • Removed unnecessary bolding.
  • Added periods to the ends of sentences.
  • Minor grammar edits.

PR Checklist

  • [ x] My code adheres to AppFlowy's Conventions
  • [ yes] I've listed at least one issue that this PR fixes in the description above.
  • [NA ] I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
  • [ x] All existing tests are passing.

Summary by Sourcery

Update README.md with consistent heading casing, clearer link text, improved punctuation, and minor grammar edits

Documentation:

  • Normalize all headings to sentence case
  • Replace vague link text (e.g., "here") with descriptive text
  • Remove unnecessary bold formatting from the document
  • Add periods at the end of sentences
  • Apply minor grammar corrections across the README

Copy link
Contributor

sourcery-ai bot commented Jun 26, 2025

Reviewer's Guide

This PR updates the README.md to enforce consistent sentence-case headings, improve link descriptions, and correct punctuation and grammar through targeted text edits without altering structure.

File-Level Changes

Change Details Files
Normalized headings to sentence case
  • Changed “User Installation” to “Installation options”
  • Changed “Built With” to “Built with”
  • Changed “Stay Up-to-Date” to “Stay up-to-date”
  • Changed “Getting Started with development” to “Getting started with development”
  • Removed bold markup from “Releases” header
  • Lowercased “Why Are We Building This?” to “Why are we building this?”
README.md
Refined link text wording and placement
  • Replaced vague “here” links with descriptive labels
  • Consolidated OS-specific instructions into a single “Building from Source” reference
  • Clarified feature request and bug report sentences
  • Updated changelog link phrasing
README.md
Standardized punctuation and formatting
  • Added periods at ends of list items and sentences
  • Removed unnecessary bold styling around headings
  • Adjusted spacing around emojis and symbols
README.md
Performed minor grammar refinements
  • Replaced “which” with “that” for restrictive clauses
  • Added hyphen in “OS-specific”
  • Reworded segments for clarity and flow
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @oddlittlebird - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

2 participants