docs(readme): add husky section (#187)

Co-authored-by: Nikita Almanov <131481562+nikkeyl@users.noreply.github.com>
archoleat · Jan 26, 2024 · 73cd375 · 73cd375
1 parent dc66475
commit 73cd375
Showing 1 changed file with 85 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -11,24 +11,52 @@
 
 ## Table of Contents
 
--   [Getting Started](#getting-started)
--   [Features](#features)
--   [Package.json scripts](#packagejson-scripts)
--   [Workflows](#workflows)
--   [Template for NPM Package](#template-for-npm-package)
--   [Markdown](#markdown)
--   [JavaScript & TypeScript](#javascript--typescript)
--   [Prettier](#prettier)
--   [Using Bots](#using-bots)
--   [If You're Building a Website](#if-youre-building-a-website)
--   [Helpers](#helpers)
--   [Change of Maintainer](#change-of-maintainer)
--   [Authors](#authors)
--   [Contributors](#contributors)
--   [Contributing](#contributing)
--   [Versioning](#versioning)
--   [License](#license)
--   [Acknowledgments](#acknowledgments)
+-   [Conqueror Repo Template](#conqueror-repo-template)
+    -   [Table of Contents](#table-of-contents)
+
+    -   [**Stop Wasting Time on Repository Build-up!**](#stop-wasting-time-on-repository-build-up)
+
+    -   [Getting Started](#getting-started)
+
+    -   [Features](#features)
+
+    -   [Package.json scripts](#packagejson-scripts)
+
+    -   [Workflows](#workflows)
+
+    -   [Template for NPM Package](#template-for-npm-package)
+
+    -   [Markdown](#markdown)
+
+    -   [JavaScript \& TypeScript](#javascript--typescript)
+
+    -   [Prettier](#prettier)
+
+    -   [Using Bots](#using-bots)
+
+    -   [If You're Building a Website](#if-youre-building-a-website)
+        -   [Conqueror](#conqueror)
+        -   [Browtest](#browtest)
+
+    -   [Change of Maintainer](#change-of-maintainer)
+
+    -   [Helpers](#helpers)
+
+    -   [Visual Studio Code](#visual-studio-code)
+
+    -   [Husky](#husky)
+
+    -   [Authors](#authors)
+
+    -   [Contributors](#contributors)
+
+    -   [Contributing](#contributing)
+
+    -   [Versioning](#versioning)
+
+    -   [License](#license)
+
+    -   [Acknowledgments](#acknowledgments)
 
 ## **Stop Wasting Time on Repository Build-up!**
 
@@ -56,7 +84,7 @@ This template includes ready-made solutions for integration with:
 -   **Auto Merge Bot**.
 -   **Issue & Pull Request Templates**.
 
-> [!TIP]
+> \[!TIP]
 > **A good solution for your business!**
 >
 > Now you don't have to worry about unnecessary costs.
@@ -155,9 +183,9 @@ This template includes ready-made solutions for integration with:
 
 ## Package.json scripts
 
--   **`init`**: Installs **node_modules** and **husky**.
+-   **`init`**: Installs **`node_modules`** and **`Husky`**.
 
--   **`lint:editorconfig`**: Runs **`editorconfig-checker`** and
+-   **`lint:editorconfig`**: Runs **`Editorconfig Checker`** and
     checks all files in the project.
 
     > Also runs with the [**`editorconfig.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/editorconfig.yml)
@@ -166,23 +194,23 @@ This template includes ready-made solutions for integration with:
 -   **`fix:prettier`**: Runs **`Prettier`** with the **`--write`** flag.
 
     > In the [**`prettier.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/prettier.yml)
-    > workflow, **`prettier`** is run with the **`--check`** flag.
+    > workflow, **`Prettier`** is run with the **`--check`** flag.
     >
     > Also run with a **`pre-commit`** hook.
 
--   **`lint:remark`**: Runs **`remark`** with the **`--quiet`** flag and
+-   **`lint:markdown`**: Runs **`Remark`** with the **`--quiet`** flag and
     checks all markdown files.
 
     > Also runs with the [**`markdown.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/markdown.yml)
     > workflow.
 
--   **`lint:eslint`**: Runs **`eslint`** with the flags **`--fix`** and
-    **`--no-error-on-unmatched-pattern`** flags for all **TypeScript** files.
+-   **`lint:ts`**: Runs **`ESLint`** with the flag **`--fix`**
+    for all **TypeScript** files.
 
     > Also runs with the [**`eslint.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/eslint.yml)
     > workflow.
 
--   **`test`**: Runs **`Mocha`** and the tests in the **\_\_tests\_\_/** folder.
+-   **`test`**: Runs **`Mocha`** and the tests in the **specs/** folder.
 
     > Also runs using the [**`mocha.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/mocha.yml)
     > workflow.
@@ -200,6 +228,9 @@ This template includes ready-made solutions for integration with:
 -   **`create-pull-request.yml`**: Automatically creates a Pull Request
     when pushing a branch to the repository.
 
+-   **`dependabot-auto-merge-pull-request.yml`**: Automatically merges
+    dependabot Pull Requests to the **main** branch.
+
 -   **`editorconfig.yml`**: Checks all files with **editorconfig-checker**.
 
 -   **`eslint.yml`**: Checks all **TypeScript** files with **ESLint**.
@@ -230,35 +261,35 @@ Everything you need is already configured in it.
 
 ## Markdown
 
-> [!TIP]
+> \[!TIP]
 > All **markdown** files here can also be used as a template!
 
 ## JavaScript & TypeScript
 
-> [!WARNING]
+> \[!WARNING]
 > This template is fully customized with **JavaScript ES6**.
 >
 > Also, only **TypeScript** is used here.
 
 ## Prettier
 
-> [!WARNING]
+> \[!WARNING]
 > You need to install the **Prettier** extension for it to work.
 >
 > You can see all necessary extensions for **Visual Studio Code** in
 > [**Conqueror Helpers**](https://github.com/Conqueror-Site-Builder/.vscode/settings.json).
 
-> [!TIP]
+> \[!TIP]
 > If you want to change the rules in **`.prettierrc.json`** you can do it
 > in **`.editorconfig`**, prettier will automatically pick up the rules
 > from editorconfig.
 
-> [!NOTE]
+> \[!NOTE]
 > All **markdown** and **ignore** files [**ignored**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.prettierignore).
 
 ## Using Bots
 
-> [!WARNING]
+> \[!WARNING]
 > To use
 > [**Welcome Bot**](https://github.com/apps/welcome) and
 > [**Auto Merge Bot**](https://github.com/apps/probot-auto-merge)
@@ -285,6 +316,23 @@ is an application for testing in (**WebKit**) Safari, (**Gecko**) Firefox and
 the site in all the necessary browsers, also it will be a salvation for
 those who do not have the opportunity to buy **Apple** products.
 
+## Change of Maintainer
+
+The following files use the name **nikkeyl** by default:
+
+-   [**`AUTHORS.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/AUTHORS.md).
+-   [**`CODE_OF_CONDUCT.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/CODE_OF_CONDUCT.md).
+-   [**`CODEOWNERS`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/CODEOWNERS).
+-   [**`bug-report.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/bug-report.yml).
+-   [**`enhancement-request.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/enhancement-request.yml).
+-   [**`docs-enhancement.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/docs-enhancement.yml).
+
+Before using this template, replace this name with your
+name or the name of your team.
+
+> \[!CAUTION]
+> Don't forget to change your license!
+
 ## Helpers
 
 If you want to further customize your repository or Visual Studio Code,
@@ -299,22 +347,14 @@ this package holds:
 -   **`.gitmessage.txt`**.
 -   **`settings.json`** for Visual Studio Code.
 
-## Change of Maintainer
-
-The following files use the name **nikkeyl** by default:
+## Visual Studio Code
 
--   [**`AUTHORS.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/AUTHORS.md).
--   [**`CODE_OF_CONDUCT.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/CODE_OF_CONDUCT.md).
--   [**`CODEOWNERS`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/CODEOWNERS).
--   [**`bug-report.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/bug-report.yml).
--   [**`enhancement-request.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/enhancement-request.yml).
--   [**`docs-enhancement.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/docs-enhancement.yml).
+Plugins and snippets for Visual Studio Code.
 
-Before using this template, replace this name with your
-name or the name of your team.
+## Husky
 
-> [!CAUTION]
-> Don't forget to change your license!
+This repository uses **.husky** as a submodule.
+**.husky** runs `pre commit` hook and `lint commit message`.
 
 ## Authors