-
-
Notifications
You must be signed in to change notification settings - Fork 477
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* README: Fix spelling mistakes * README: Rename OSX to macOS * CONTRIBUTING: Fix spelling mistakes
- Loading branch information
Showing
2 changed files
with
8 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,17 @@ | ||
## bootstrapping | ||
|
||
This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions) action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript. | ||
This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions) action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript. | ||
|
||
You can bootstrap your envrinment with a modern version of npm and by running `npm i` at the root of this repo. | ||
You can bootstrap your environment with a modern version of npm and by running `npm i` at the root of this repo. | ||
|
||
## testing | ||
|
||
Tests can be found under under `__tests__` directory and are runnable with the `npm t` command | ||
Tests can be found under under `__tests__` directory and are runnable with the `npm t` command. | ||
|
||
## source code | ||
|
||
Source code can be found under the `src` directory. Running `npm run build` will generate the JavaScript that will run within GitHub workflows. | ||
|
||
## formatting | ||
|
||
A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt` | ||
|
||
A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters