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

fix: typos #830

Merged
merged 4 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion BUILD_SYSTEM.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This monorepo implements a custom build system using a combination of tools:

- [Yarn](https://yarnpkg.com) (for dependency management)
- [`wsrun`](https://github.com/hfour/wsrun) (for running workspace scripts)
- [ESBuild](https://esbuild.github.io) (for transpilation, minifaction, and bundling of source codes)
- [ESBuild](https://esbuild.github.io) (for transpilation, minification, and bundling of source codes)
- [TypeScript](https://www.typescriptlang.org) (for static typing)
- [ESLint](https://eslint.org) (for TypeScript/JavaScript linting)

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Please note we have a **code of conduct**, please follow it in all your interact

## Setting up for local development

1. Fork this repostiory.
1. Fork this repository.
2. Clone your fork.
3. Create a new branch in your local repository with the following pattern:

Expand Down Expand Up @@ -44,10 +44,10 @@ To ensure ESLint is able to properly lint source files in your VS Code developme
| NPM Script | Usage | Description |
| ---------- | ----- | ----------- |
| `wsrun` | `PKG=$PACKAGE_TARGET yarn wsrun` | Execute arbitrary scripts via `wsrun` for the specified package, or interactively select a package if `$PKG` is omitted. |
| `wsrun:all` | `yarn wsrun` | Execute arbitrary scripts via `wsrun` for the all packages in the monorepo (same as `PKG=* yarn wsrun ...`). |
| `wsrun:all` | `yarn wsrun` | Execute arbitrary scripts via `wsrun` for all packages in the monorepo (same as `PKG=* yarn wsrun ...`). |
| `dev` | `PKG=$PACKAGE_TARGET yarn dev` | Build the specified package with a hot-reloading dev server, or interactively select a package if `$PKG` is omitted. |
| `build` | `PKG=$PACKAGE_TARGET yarn build` | Build the specified package for production, or interactively select a package if `$PKG` is omitted. |
| `clean` | `PKG=$PACKAGE_TARGET yarn clean` | Run cleaning scripts for the specified package,or interactively select a package if `$PKG` is omitted. Available flags: (`--cache`, `--test-artifacts`, `--deps`) |
| `clean` | `PKG=$PACKAGE_TARGET yarn clean` | Run cleaning scripts for the specified package, or interactively select a package if `$PKG` is omitted. Available flags: (`--cache`, `--test-artifacts`, `--deps`) |
| `lint` | `PKG=$PACKAGE_TARGET yarn lint` | Run the linter for the specified package, or interactively select a package if `$PKG` is omitted. |
| `test` | `PKG=$PACKAGE_TARGET yarn test` | Run tests for the specified package, or interactively select a package if `$PKG` is omitted. |

Expand All @@ -59,7 +59,7 @@ To ensure ESLint is able to properly lint source files in your VS Code developme

## Cutting a release

We use [`auto`](https://github.com/intuit/auto) as our continous delivery tool. Cutting a release is just a matter of merging to `master`. For pre-releases, you can create a `next` branch as the base for your experimental/W.I.P. feature. Please familiarize yourself with the [documentation for `auto`](https://intuit.github.io/auto/docs) if you are in a position to cut a release.
We use [`auto`](https://github.com/intuit/auto) as our continuous delivery tool. Cutting a release is just a matter of merging to `master`. For pre-releases, you can create a `next` branch as the base for your experimental/W.I.P. feature. Please familiarize yourself with the [documentation for `auto`](https://intuit.github.io/auto/docs) if you are in a position to cut a release.

---

Expand Down