From 2c23bc445c0666de384b8433db46a72be16f1f95 Mon Sep 17 00:00:00 2001 From: Yoni Goldberg Date: Mon, 29 Nov 2021 11:28:55 +0200 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 60437b38..94dd2e51 100644 --- a/README.md +++ b/README.md @@ -52,11 +52,11 @@ Read in a different language: [![CN](./assets/flags/CN.png)**CN**](./README.chin 1. Project Structure Practices (5) -  [1.1 Structure your solution by components `strategic`](#-11-structure-your-solution-by-components)
+  [1.1 Structure your solution by components `#strategic`](#-11-structure-your-solution-by-components)
  [1.2 Layer your components, keep the web layer within its boundaries](#-12-layer-your-components-keep-the-web-layer-within-its-boundaries)
  [1.3 Wrap common utilities as npm packages](#-13-wrap-common-utilities-as-npm-packages)
  [1.4 Separate Express 'app' and 'server'](#-14-separate-express-app-and-server)
-  [1.5 Use environment aware, secure and hierarchical config `modified-recently`](#-15-use-environment-aware-secure-and-hierarchical-config)
+  [1.5 Use environment aware, secure and hierarchical config `#modified-recently`](#-15-use-environment-aware-secure-and-hierarchical-config)
@@ -66,7 +66,7 @@ Read in a different language: [![CN](./assets/flags/CN.png)**CN**](./README.chin   [2.1 Use Async-Await or promises for async error handling](#-21-use-async-await-or-promises-for-async-error-handling)
-  [2.2 Use only the built-in Error object `strategic`](#-22-use-only-the-built-in-error-object)
+  [2.2 Use only the built-in Error object `#strategic`](#-22-use-only-the-built-in-error-object)
  [2.3 Distinguish operational vs programmer errors](#-23-distinguish-operational-vs-programmer-errors)
  [2.4 Handle errors centrally, not within a middleware](#-24-handle-errors-centrally-not-within-a-middleware)
  [2.5 Document API errors using Swagger or GraphQL](#-25-document-api-errors-using-swagger-or-graphql)
@@ -76,7 +76,7 @@ Read in a different language: [![CN](./assets/flags/CN.png)**CN**](./README.chin   [2.9 Discover errors and downtime using APM products](#-29-discover-errors-and-downtime-using-apm-products)
  [2.10 Catch unhandled promise rejections](#-210-catch-unhandled-promise-rejections)
  [2.11 Fail fast, validate arguments using a dedicated library](#-211-fail-fast-validate-arguments-using-a-dedicated-library)
-  [2.12 Always await promises before returning to avoid a partial stacktrace `new`](#-212-always-await-promises-before-returning-to-avoid-a-partial-stacktrace)
+  [2.12 Always await promises before returning to avoid a partial stacktrace `#new`](#-212-always-await-promises-before-returning-to-avoid-a-partial-stacktrace)
@@ -85,7 +85,7 @@ Read in a different language: [![CN](./assets/flags/CN.png)**CN**](./README.chin 3. Code Style Practices (12) -  [3.1 Use ESLint](#-31-use-eslint)
+  [3.1 Use ESLint `#strategic`](#-31-use-eslint)
  [3.2 Node.js specific plugins](#-32-nodejs-specific-plugins)
  [3.3 Start a Codeblock's Curly Braces on the Same Line](#-33-start-a-codeblocks-curly-braces-on-the-same-line)
  [3.4 Separate your statements properly](#-34-separate-your-statements-properly)
@@ -105,9 +105,9 @@ Read in a different language: [![CN](./assets/flags/CN.png)**CN**](./README.chin 4. Testing And Overall Quality Practices (13) -  [4.1 At the very least, write API (component) testing](#-41-at-the-very-least-write-api-component-testing)
-  [4.2 Include 3 parts in each test name](#-42-include-3-parts-in-each-test-name)
-  [4.3 Structure tests by the AAA pattern](#-43-structure-tests-by-the-aaa-pattern)
+  [4.1 At the very least, write API (component) testing `#strategic`](#-41-at-the-very-least-write-api-component-testing)
+  [4.2 Include 3 parts in each test name `#new`](#-42-include-3-parts-in-each-test-name)
+  [4.3 Structure tests by the AAA pattern `#strategic`](#-43-structure-tests-by-the-aaa-pattern)
  [4.4 Detect code issues with a linter](#-44-detect-code-issues-with-a-linter)
  [4.5 Avoid global test fixtures and seeds, add data per-test](#-45-avoid-global-test-fixtures-and-seeds-add-data-per-test)
  [4.6 Constantly inspect for vulnerable dependencies](#-46-constantly-inspect-for-vulnerable-dependencies)