Merge branch 'master' into leecalcote/blog/cost-of-observability

.github/workflows/checks.yml

@@ -0,0 +1,25 @@
+name: Checks
+on:
+  pull_request:
+    branches: [ master ]
+    types: [opened, synchronize, reopened]
+
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@master
+        with:
+          persist-credentials: false
+          fetch-depth: 1
+
+      - name: NPM Install
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Run Eslint
+        run: npm run checklint

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run checklint
+npx lint-staged

CONTRIBUTING.md

@@ -558,6 +558,18 @@ git push -u origin <your_branch_name>
 
 **15.** Once you’ve committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. Please ensure that you compare your feature branch to the desired branch of the repo you are supposed to make a PR to. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes in your development branch and update it.
 
+### Lint Rules
+
+Layer5 uses ESLint to maintain code quality and consistency in our UI code.  Use this command to trigger a lint check:
+
+```sh
+make lint
+```
+
+> Note:
+>     - Eslint in Gatsby requires generating config files from CLI. Run `gatsby build` or `gatsby develop` if you face this error during linting.
+
+
 ## Signing-off on Commits
 
 To contribute to this project, you must agree to the **Developer Certificate of

Makefile

@@ -37,4 +37,8 @@ build:
 clean: 
 	gatsby clean && make site
 
-.PHONY: setup build site clean site-fast
+## Run Eslint on your local machine.
+lint:
+	npm run lint
+
+.PHONY: setup build site clean site-fast lint