Skip to content

Commit 73cd375

Browse files
github-actions[bot]nikkeyl
github-actions[bot]
and
nikkeyl
authored
docs(readme): add husky section (#187)
Co-authored-by: Nikita Almanov <[email protected]>
1 parent dc66475 commit 73cd375

File tree

1 file changed

+85
-45
lines changed

1 file changed

+85
-45
lines changed

‎README.md

Lines changed: 85 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,52 @@
1111

1212
## Table of Contents
1313

14-
- [Getting Started](#getting-started)
15-
- [Features](#features)
16-
- [Package.json scripts](#packagejson-scripts)
17-
- [Workflows](#workflows)
18-
- [Template for NPM Package](#template-for-npm-package)
19-
- [Markdown](#markdown)
20-
- [JavaScript & TypeScript](#javascript--typescript)
21-
- [Prettier](#prettier)
22-
- [Using Bots](#using-bots)
23-
- [If You're Building a Website](#if-youre-building-a-website)
24-
- [Helpers](#helpers)
25-
- [Change of Maintainer](#change-of-maintainer)
26-
- [Authors](#authors)
27-
- [Contributors](#contributors)
28-
- [Contributing](#contributing)
29-
- [Versioning](#versioning)
30-
- [License](#license)
31-
- [Acknowledgments](#acknowledgments)
14+
- [Conqueror Repo Template](#conqueror-repo-template)
15+
- [Table of Contents](#table-of-contents)
16+
17+
- [**Stop Wasting Time on Repository Build-up!**](#stop-wasting-time-on-repository-build-up)
18+
19+
- [Getting Started](#getting-started)
20+
21+
- [Features](#features)
22+
23+
- [Package.json scripts](#packagejson-scripts)
24+
25+
- [Workflows](#workflows)
26+
27+
- [Template for NPM Package](#template-for-npm-package)
28+
29+
- [Markdown](#markdown)
30+
31+
- [JavaScript \& TypeScript](#javascript--typescript)
32+
33+
- [Prettier](#prettier)
34+
35+
- [Using Bots](#using-bots)
36+
37+
- [If You're Building a Website](#if-youre-building-a-website)
38+
- [Conqueror](#conqueror)
39+
- [Browtest](#browtest)
40+
41+
- [Change of Maintainer](#change-of-maintainer)
42+
43+
- [Helpers](#helpers)
44+
45+
- [Visual Studio Code](#visual-studio-code)
46+
47+
- [Husky](#husky)
48+
49+
- [Authors](#authors)
50+
51+
- [Contributors](#contributors)
52+
53+
- [Contributing](#contributing)
54+
55+
- [Versioning](#versioning)
56+
57+
- [License](#license)
58+
59+
- [Acknowledgments](#acknowledgments)
3260

3361
## **Stop Wasting Time on Repository Build-up!**
3462

@@ -56,7 +84,7 @@ This template includes ready-made solutions for integration with:
5684
- **Auto Merge Bot**.
5785
- **Issue & Pull Request Templates**.
5886

59-
> [!TIP]
87+
> \[!TIP]
6088
> **A good solution for your business!**
6189
>
6290
> Now you don't have to worry about unnecessary costs.
@@ -155,9 +183,9 @@ This template includes ready-made solutions for integration with:
155183

156184
## Package.json scripts
157185

158-
- **`init`**: Installs **node_modules** and **husky**.
186+
- **`init`**: Installs **`node_modules`** and **`Husky`**.
159187

160-
- **`lint:editorconfig`**: Runs **`editorconfig-checker`** and
188+
- **`lint:editorconfig`**: Runs **`Editorconfig Checker`** and
161189
checks all files in the project.
162190

163191
> 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:
166194
- **`fix:prettier`**: Runs **`Prettier`** with the **`--write`** flag.
167195

168196
> In the [**`prettier.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/prettier.yml)
169-
> workflow, **`prettier`** is run with the **`--check`** flag.
197+
> workflow, **`Prettier`** is run with the **`--check`** flag.
170198
>
171199
> Also run with a **`pre-commit`** hook.
172200
173-
- **`lint:remark`**: Runs **`remark`** with the **`--quiet`** flag and
201+
- **`lint:markdown`**: Runs **`Remark`** with the **`--quiet`** flag and
174202
checks all markdown files.
175203

176204
> Also runs with the [**`markdown.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/markdown.yml)
177205
> workflow.
178206
179-
- **`lint:eslint`**: Runs **`eslint`** with the flags **`--fix`** and
180-
**`--no-error-on-unmatched-pattern`** flags for all **TypeScript** files.
207+
- **`lint:ts`**: Runs **`ESLint`** with the flag **`--fix`**
208+
for all **TypeScript** files.
181209

182210
> Also runs with the [**`eslint.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/eslint.yml)
183211
> workflow.
184212
185-
- **`test`**: Runs **`Mocha`** and the tests in the **\_\_tests\_\_/** folder.
213+
- **`test`**: Runs **`Mocha`** and the tests in the **specs/** folder.
186214

187215
> Also runs using the [**`mocha.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/mocha.yml)
188216
> workflow.
@@ -200,6 +228,9 @@ This template includes ready-made solutions for integration with:
200228
- **`create-pull-request.yml`**: Automatically creates a Pull Request
201229
when pushing a branch to the repository.
202230

231+
- **`dependabot-auto-merge-pull-request.yml`**: Automatically merges
232+
dependabot Pull Requests to the **main** branch.
233+
203234
- **`editorconfig.yml`**: Checks all files with **editorconfig-checker**.
204235

205236
- **`eslint.yml`**: Checks all **TypeScript** files with **ESLint**.
@@ -230,35 +261,35 @@ Everything you need is already configured in it.
230261

231262
## Markdown
232263

233-
> [!TIP]
264+
> \[!TIP]
234265
> All **markdown** files here can also be used as a template!
235266
236267
## JavaScript & TypeScript
237268

238-
> [!WARNING]
269+
> \[!WARNING]
239270
> This template is fully customized with **JavaScript ES6**.
240271
>
241272
> Also, only **TypeScript** is used here.
242273
243274
## Prettier
244275

245-
> [!WARNING]
276+
> \[!WARNING]
246277
> You need to install the **Prettier** extension for it to work.
247278
>
248279
> You can see all necessary extensions for **Visual Studio Code** in
249280
> [**Conqueror Helpers**](https://github.com/Conqueror-Site-Builder/.vscode/settings.json).
250281
251-
> [!TIP]
282+
> \[!TIP]
252283
> If you want to change the rules in **`.prettierrc.json`** you can do it
253284
> in **`.editorconfig`**, prettier will automatically pick up the rules
254285
> from editorconfig.
255286
256-
> [!NOTE]
287+
> \[!NOTE]
257288
> All **markdown** and **ignore** files [**ignored**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.prettierignore).
258289
259290
## Using Bots
260291

261-
> [!WARNING]
292+
> \[!WARNING]
262293
> To use
263294
> [**Welcome Bot**](https://github.com/apps/welcome) and
264295
> [**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
285316
the site in all the necessary browsers, also it will be a salvation for
286317
those who do not have the opportunity to buy **Apple** products.
287318

319+
## Change of Maintainer
320+
321+
The following files use the name **nikkeyl** by default:
322+
323+
- [**`AUTHORS.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/AUTHORS.md).
324+
- [**`CODE_OF_CONDUCT.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/CODE_OF_CONDUCT.md).
325+
- [**`CODEOWNERS`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/CODEOWNERS).
326+
- [**`bug-report.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/bug-report.yml).
327+
- [**`enhancement-request.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/enhancement-request.yml).
328+
- [**`docs-enhancement.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/docs-enhancement.yml).
329+
330+
Before using this template, replace this name with your
331+
name or the name of your team.
332+
333+
> \[!CAUTION]
334+
> Don't forget to change your license!
335+
288336
## Helpers
289337

290338
If you want to further customize your repository or Visual Studio Code,
@@ -299,22 +347,14 @@ this package holds:
299347
- **`.gitmessage.txt`**.
300348
- **`settings.json`** for Visual Studio Code.
301349

302-
## Change of Maintainer
303-
304-
The following files use the name **nikkeyl** by default:
350+
## Visual Studio Code
305351

306-
- [**`AUTHORS.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/AUTHORS.md).
307-
- [**`CODE_OF_CONDUCT.md`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/CODE_OF_CONDUCT.md).
308-
- [**`CODEOWNERS`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/CODEOWNERS).
309-
- [**`bug-report.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/bug-report.yml).
310-
- [**`enhancement-request.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/enhancement-request.yml).
311-
- [**`docs-enhancement.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/ISSUE_TEMPLATE/docs-enhancement.yml).
352+
Plugins and snippets for Visual Studio Code.
312353

313-
Before using this template, replace this name with your
314-
name or the name of your team.
354+
## Husky
315355

316-
> [!CAUTION]
317-
> Don't forget to change your license!
356+
This repository uses **.husky** as a submodule.
357+
**.husky** runs `pre commit` hook and `lint commit message`.
318358

319359
## Authors
320360

0 commit comments

Comments
 (0)