Skip to content

docs: improve README wording and fix grammar issues #3341

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.

Sign up for GitHub

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
Dorra21 wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −10
Open

docs: improve README wording and fix grammar issues #3341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
[![GitHub All Releases](https://img.shields.io/github/downloads/RocketChat/Rocket.Chat.Electron/total.svg)](https://github.com/RocketChat/Rocket.Chat.Electron/releases/latest)
![GitHub](https://img.shields.io/github/license/RocketChat/Rocket.Chat.Electron.svg)

Desktop application for [Rocket.Chat][] available for macOS, Windows and Linux
using [Electron][].
Desktop application for [Rocket.Chat][], available for macOS, Windows, and Linux,
built using [Electron][].

![Rocket.Chat Desktop App](https://user-images.githubusercontent.com/2263066/91490997-c0bd0c80-e889-11ea-92c7-2cbcc3aabc98.png)

Expand All @@ -31,8 +31,8 @@ We'd love to hear about [your experience][] and potentially feature it on our

### Subscribe for Updates

Once a month our marketing team releases an email update with news about product
releases, company related topics, events and use cases. [Sign Up!][]
Once a month, our marketing team sends an email update featuring product
releases, company-related topics, events, and use cases.

---

Expand All @@ -50,7 +50,7 @@ Launch the installer and follow the instructions to install.

### Windows Options

On Windows you can run a silent install by adding the `/S` flag. You can also
On Windows, you can run a silent installation by adding the `/S` flag. You can also
add the options below:

- `/S` - Silent install
Expand Down Expand Up @@ -82,7 +82,7 @@ yarn start
The source is located in the `src` folder. Everything in this folder will be
built automatically when running the app with `yarn start`.

The build process compiles all stuff from the `src` folder and puts it into the
The build process compiles all files from the `src` folder and puts it into the
`app` folder, so after the build has finished, your `app` folder contains the
full, runnable application.

Expand All @@ -93,7 +93,7 @@ rewritten in TypeScript 5 to address issues regarding maintainability.

### The build pipeline

The build process is founded upon [rollup][] bundler. There are three entry files
The build process is based on the [rollup][] bundler. There are three entry files
for your code:

- `src/main.ts`, the script running at the main Electron process, orchestrating
Expand Down Expand Up @@ -143,14 +143,13 @@ for all files in `src` directory that match the glob pattern

### Making a release

To package your app into an installer use command:
To package your app into an installer, use the following command:

```sh
yarn release
```

It will start the packaging process for operating system you are running this
command on. Ready for distribution file will be outputted to `dist` directory.
It will start the packaging process for the operating system on which you are running this command. Ready for distribution file will be outputted to `dist` directory.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 25, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix grammar and word choice issues.

This sentence has several issues:

  • "Ready for distribution file" should be hyphenated as a compound adjective: "ready-for-distribution file"
  • "outputted" should be "output" (standard past participle)
  • Missing article "the" before "dist directory"
✏️ Proposed fix 
-It will start the packaging process for the operating system on which you are running this command. Ready for distribution file will be outputted to `dist` directory.
+It will start the packaging process for the operating system you are running this command on. The ready-for-distribution file will be output to the `dist` directory.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
It will start the packaging process for the operating system on which you are running this command. Ready for distribution file will be outputted to `dist` directory.
It will start the packaging process for the operating system you are running this command on. The ready-for-distribution file will be output to the `dist` directory.
🧰 Tools
🪛 LanguageTool

[grammar] ~152-~152: Use a hyphen to join words.
Context: ... you are running this command. Ready for distribution file will be outputted to `...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 152, Replace the sentence "It will start the packaging
process for the operating system on which you are running this command. Ready
for distribution file will be outputted to `dist` directory." with a
grammatically corrected version: "It will start the packaging process for the
operating system on which you are running this command. The
ready-for-distribution file will be output to the `dist` directory." — update
the README line that contains "Ready for distribution file" and "outputted" to
use the hyphenated compound adjective, "output" as the past participle, and
include the article "the" before "dist directory".


All packaging actions are handled by [electron-builder][]. It has a lot of
[customization options][].
Expand Down