From b21b43df682dab285bf5146c1955e7f3560805f8 Mon Sep 17 00:00:00 2001 From: softprops Date: Mon, 9 Sep 2019 21:59:28 +0900 Subject: [PATCH] empathy for those new to typescript projects --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..839b466 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## 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. + +You can bootstrap your envrinment 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 + +## 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` +