Skip to content

Commit de9e657

Browse files
docs: fix grammar + typos (#10661)
Co-authored-by: Brooks Lybrand <[email protected]>
1 parent 0e9d40e commit de9e657

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
# Remix Releases
44

5-
This page lists all releases/release notes for Remix back to `v2.0.0`. For releases prior to v2, please refer to the [Github Releases Page](https://github.com/remix-run/remix/releases).
5+
This page lists all releases/release notes for Remix back to `v2.0.0`. For releases prior to v2, please refer to the [GitHub Releases Page](https://github.com/remix-run/remix/releases).
66

7-
We manage release notes in this file instead of the paginated Github Releases Page for 2 reasons:
7+
We manage release notes in this file instead of the paginated GitHub Releases Page for 2 reasons:
88

9-
- Pagination in the Github UI means that you cannot easily search release notes for a large span of releases at once
10-
- The paginated Github interface also cuts off longer releases notes without indication in list view, and you need to click into the detail view to see the full set of release notes
9+
- Pagination in the GitHub UI means that you cannot easily search release notes for a large span of releases at once
10+
- The paginated GitHub interface also cuts off longer releases notes without indication in list view, and you need to click into the detail view to see the full set of release notes
1111

1212
<details>
1313
<summary>Table of Contents</summary>

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Examples of unacceptable behavior include:
3131

3232
- The use of sexualized language or imagery, and sexual attention or
3333
advances of any kind
34-
- Trolling, insulting or derogatory comments, and personal or political attacks
34+
- Trolling, insulting, or derogatory comments, and personal or political attacks
3535
- Public or private harassment
3636
- Publishing others' private information, such as a physical or email
3737
address, without their explicit permission
38-
- Other conduct which could reasonably be considered inappropriate in a
38+
- Other conduct, which could reasonably be considered inappropriate in a
3939
professional setting
4040

4141
## Enforcement Responsibilities

DEVELOPMENT.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pnpm test:integration integration/client-data --project chromium
3838

3939
New releases should be created from release branches originating from the `dev` branch. When you are ready to begin the release process:
4040

41-
- Make sure you've pulled all of the changes from GitHub for both `dev` and `main` branches
41+
- Make sure you've pulled all the changes from GitHub for both `dev` and `main` branches
4242
- Check out the `dev` branch
4343
- If needed, bump the dependencies to the correct React Router release
4444
- `./scripts/bump-router-versions.sh [pre|latest]`
@@ -54,7 +54,7 @@ Changesets will do most of the heavy lifting for our releases. When changes are
5454
- Ensure you are on the new `release-*` branch
5555
- Enter Changesets pre-release mode using the `pre` tag: `pnpm changeset pre enter pre`
5656
- Commit the change and push the `release-*` branch to GitHub
57-
- Wait for the release workflow to finish - the Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs
57+
- Wait for the release workflow to finish the Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs
5858
- Review the updated `CHANGELOG` files and make any adjustments necessary, then merge the PR into the `release-*` branch
5959
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
6060
- Once the PR is merged, the release workflow will publish the updated packages to npm
@@ -65,12 +65,12 @@ Changesets will do most of the heavy lifting for our releases. When changes are
6565

6666
### Iterating a pre-release
6767

68-
You may need to make changes to a pre-release prior to publishing a final stable release. To do so:
68+
You may need to make changes to a pre-release before publishing a final stable release. To do so:
6969

7070
- Make whatever changes you need
7171
- Create a new changeset: `pnpm changeset`
7272
- **IMPORTANT:** This is required even if you ultimately don't want to include these changes in the logs
73-
- Remember, changelogs can be edited prior to publishing, but the Changeset version script needs to see new changesets in order to create a new version
73+
- Remember, changelogs can be edited before publishing, but the Changeset version script needs to see new changesets to create a new version
7474
- Commit the changesets and push the `release-*` branch to GitHub
7575
- Wait for the release workflow to finish and the Changesets action to open its PR that will increment all versions
7676
- Review the PR, make any adjustments necessary, and merge it into the `release-*` branch
@@ -81,7 +81,7 @@ You may need to make changes to a pre-release prior to publishing a final stable
8181

8282
- Exit Changesets pre-release mode: `pnpm changeset pre exit`
8383
- Commit the edited `pre.json` file along with any unpublished changesets, and push the `release-*` branch to GitHub
84-
- Wait for the release workflow to finish - the Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs for the stable release
84+
- Wait for the release workflow to finish the Changesets action in the workflow will open a PR that will increment all versions and generate the changelogs for the stable release
8585
- Review the updated `CHANGELOG` files and make any adjustments necessary
8686
- `find packages -name 'CHANGELOG.md' -mindepth 2 -maxdepth 2 -exec code {} \;`
8787
- Our automated release process should have removed prerelease entries
@@ -104,25 +104,25 @@ Hotfix releases follow the same process as standard releases above, but the `rel
104104

105105
### Experimental releases
106106

107-
Experimental releases use a [manually-triggered Github Actions workflow](./.github/workflows/release-experimental.yml) and can be built from any existing branch. to build and publish an experimental release:
107+
Experimental releases use a [manually triggered GitHub Actions workflow](./.github/workflows/release-experimental.yml) and can be built from any existing branch. To build and publish an experimental release:
108108

109109
- Commit your changes to a branch
110-
- Push the branch to github
111-
- Go to the Github Actions UI for the [release-experimental.yml workflow](https://github.com/remix-run/remix/actions/workflows/release-experimental-dispatch.yml)
110+
- Push the branch to GitHub
111+
- Go to the GitHub Actions UI for the [release-experimental.yml workflow](https://github.com/remix-run/remix/actions/workflows/release-experimental-dispatch.yml)
112112
- Click the `Run workflow` dropdown
113113
- Leave the `Use workflow from` dropdown as `main`
114114
- Enter your feature branch in the `branch` input
115115
- Click the `Run workflow` button
116116

117117
### Nightly releases
118118

119-
Nightly releases happen automatically at midnight PST via a [cron-driven workflow](./.github/workflows/nightly.yml) that is essentially the same as the experimental releases, but also performs some validations after the release.
119+
Nightly releases happen automatically at midnight PST via a [cron-driven workflow](./.github/workflows/nightly.yml) that is essentially the same as the experimental releases but also performs some validations after the release.
120120

121121
## Local Development Tips and Tricks
122122

123123
### Environment Variables
124124

125-
This repository supports handful of environment variables to streamline the local development/testing process.
125+
This repository supports a handful of environment variables to streamline the local development/testing process.
126126

127127
**`REMIX_DEBUG`**
128128

@@ -134,7 +134,7 @@ REMIX_DEBUG=true pnpm watch
134134

135135
**`LOCAL_BUILD_DIRECTORY`**
136136

137-
When developing Remix locally, you often need to go beyond unit/integration tests and test your changes in a local Remix application. The easiest way to do this is to run your local Remix build and use this environment variable to direct `rollup` to write the output files directly into the local Remix application's `node_modules` folder. Then you just need to restart your local Remix application server to pick up the changes.
137+
When developing Remix locally, you often need to go beyond unit/integration tests and test your changes in a local Remix application. The easiest way to do this is to run your local Remix build and use this environment variable to direct `rollup` to write the output files directly into the local Remix application's `node_modules` folder. Then you need to restart your local Remix application server to pick up the changes.
138138

139139
```sh
140140
# Tab 1 - create and run a local remix application

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
1010
We are happy you're here!
1111

12-
[Remix](https://remix.run) is a full stack web framework that lets you focus on the user interface and work back through web fundamentals to deliver a fast, slick, and resilient user experience that deploys to any Node.js server and even non-Node.js environments at the edge like Cloudflare Workers.
12+
[Remix](https://remix.run) is a full-stack web framework that lets you focus on the user interface and work back through web fundamentals to deliver a fast, slick, and resilient user experience that deploys to any Node.js server and even non-Node.js environments at the edge like Cloudflare Workers.
1313

1414
Want to know more? Read the [Technical Explanation of Remix](https://remix.run/discussion/introduction).
1515

@@ -30,4 +30,4 @@ If you're interested in contributing code and/or documentation, please see [our
3030

3131
## Code of Conduct
3232

33-
Please see our [code of conduct](CODE_OF_CONDUCT.md) for any questions about the kind of community we are trying to build here and what to do if you need help with someone who is not acting professionally.
33+
Please see our [code of conduct](CODE_OF_CONDUCT.md) for any questions about the kind of community we are trying to build here and what to do if you need help with someone not acting professionally.

0 commit comments

Comments
 (0)