diff --git a/BUILD_SYSTEM.md b/BUILD_SYSTEM.md index 4b1ddf7c..b080673e 100644 --- a/BUILD_SYSTEM.md +++ b/BUILD_SYSTEM.md @@ -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) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 974cf75b..39d11c44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: @@ -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. | @@ -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. ---