@avi2dg/checks 0.11.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +334 -151
- package/dist/feature-rules.js +255 -0
- package/package.json +29 -5
- package/quality.schema.json +191 -1
- package/scripts/doc-outline.ts +215 -0
- package/scripts/doc-rules.ts +176 -0
- package/scripts/doc-templates.ts +203 -0
- package/scripts/docs.ts +90 -0
- package/scripts/feature-owners.ts +142 -0
- package/scripts/gates.ts +3 -0
- package/scripts/git.ts +70 -14
- package/scripts/quality-file.ts +135 -4
- package/scripts/quality.ts +10 -2
- package/scripts/size-budget.ts +158 -0
- package/templates/adr.md +29 -0
- package/templates/agents.md +17 -0
- package/templates/changelog.md +37 -0
- package/templates/claude.md +2 -0
- package/templates/explanation.md +15 -0
- package/templates/how-to.md +33 -0
- package/templates/readme.md +43 -0
- package/templates/reference.md +15 -0
- package/templates/tutorial.md +31 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
Every release of <package>, newest first, written by the release from its conventional commits.
|
|
4
|
+
|
|
5
|
+
## <version>
|
|
6
|
+
|
|
7
|
+
Released <YYYY-MM-DD>.
|
|
8
|
+
|
|
9
|
+
### Breaking changes
|
|
10
|
+
|
|
11
|
+
<Leave this section out when the release holds no such commit.>
|
|
12
|
+
|
|
13
|
+
- <the commit's subject>
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
<Leave this section out when the release holds no such commit.>
|
|
18
|
+
|
|
19
|
+
- <the commit's subject>
|
|
20
|
+
|
|
21
|
+
### Fixes
|
|
22
|
+
|
|
23
|
+
<Leave this section out when the release holds no such commit.>
|
|
24
|
+
|
|
25
|
+
- <the commit's subject>
|
|
26
|
+
|
|
27
|
+
### Performance
|
|
28
|
+
|
|
29
|
+
<Leave this section out when the release holds no such commit.>
|
|
30
|
+
|
|
31
|
+
- <the commit's subject>
|
|
32
|
+
|
|
33
|
+
### Reverts
|
|
34
|
+
|
|
35
|
+
<Leave this section out when the release holds no such commit.>
|
|
36
|
+
|
|
37
|
+
- <the commit's subject>
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# <The idea this page explains, as a noun>
|
|
2
|
+
|
|
3
|
+
<The question this page answers, and the short answer.>
|
|
4
|
+
|
|
5
|
+
## <One strand of the answer>
|
|
6
|
+
|
|
7
|
+
<Leave this section out when the lead holds the whole answer.>
|
|
8
|
+
|
|
9
|
+
<The reasoning, the alternatives, and why they lost.>
|
|
10
|
+
|
|
11
|
+
## Related topics
|
|
12
|
+
|
|
13
|
+
<Leave this section out when there is no other page to send the reader to.>
|
|
14
|
+
|
|
15
|
+
- [<page title>](<path to the page>)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# <Task, verb first>
|
|
2
|
+
|
|
3
|
+
<Who does this, and when, in one or two sentences.>
|
|
4
|
+
|
|
5
|
+
## Before you begin
|
|
6
|
+
|
|
7
|
+
<Leave this section out when the task needs nothing set up first.>
|
|
8
|
+
|
|
9
|
+
- <each prerequisite, with the version it is tested on>
|
|
10
|
+
|
|
11
|
+
## <Part of the task, verb first>
|
|
12
|
+
|
|
13
|
+
<Leave this section out when the page is one task, whose steps then follow the lead.>
|
|
14
|
+
|
|
15
|
+
To <do the task>:
|
|
16
|
+
|
|
17
|
+
1. <step>
|
|
18
|
+
1. <step>
|
|
19
|
+
|
|
20
|
+
## Troubleshooting
|
|
21
|
+
|
|
22
|
+
<Leave this section out when no reader has met a failure worth naming yet.>
|
|
23
|
+
|
|
24
|
+
### <The symptom, or the error text>
|
|
25
|
+
|
|
26
|
+
<The cause.>
|
|
27
|
+
<The resolution.>
|
|
28
|
+
|
|
29
|
+
## Related topics
|
|
30
|
+
|
|
31
|
+
<Leave this section out when there is no other page to send the reader to.>
|
|
32
|
+
|
|
33
|
+
- [<page title>](<path to the page>)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# <name>
|
|
2
|
+
|
|
3
|
+
<The concept in two to four sentences: what this is, who it is for, why you would use it.>
|
|
4
|
+
|
|
5
|
+
## Before you begin
|
|
6
|
+
|
|
7
|
+
- <each prerequisite, with the version it is tested on>
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
To install <name>:
|
|
12
|
+
|
|
13
|
+
1. <step>
|
|
14
|
+
1. <step>
|
|
15
|
+
|
|
16
|
+
<What you see when it worked.>
|
|
17
|
+
|
|
18
|
+
## <Everyday task, verb first>
|
|
19
|
+
|
|
20
|
+
To <do the task>:
|
|
21
|
+
|
|
22
|
+
1. <step>
|
|
23
|
+
1. <step>
|
|
24
|
+
|
|
25
|
+
## Where things are
|
|
26
|
+
|
|
27
|
+
| Path | What it holds |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
|
|
30
|
+
## Troubleshooting
|
|
31
|
+
|
|
32
|
+
<Leave this section out when no reader has met a failure worth naming yet.>
|
|
33
|
+
|
|
34
|
+
### <The symptom, or the error text>
|
|
35
|
+
|
|
36
|
+
<The cause.>
|
|
37
|
+
<The resolution.>
|
|
38
|
+
|
|
39
|
+
## Related topics
|
|
40
|
+
|
|
41
|
+
<Leave this section out when there is no other page to send the reader to.>
|
|
42
|
+
|
|
43
|
+
- [<page title>](<path to the page>)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# <The thing this page describes, as a noun>
|
|
2
|
+
|
|
3
|
+
<What the thing is, in one sentence, and when a reader looks it up.>
|
|
4
|
+
|
|
5
|
+
## <One part of it, as a noun>
|
|
6
|
+
|
|
7
|
+
<Leave this section out when the lead and one table describe all of it.>
|
|
8
|
+
|
|
9
|
+
<A table, a list or a short description, with no steps and no opinion.>
|
|
10
|
+
|
|
11
|
+
## Related topics
|
|
12
|
+
|
|
13
|
+
<Leave this section out when there is no other page to send the reader to.>
|
|
14
|
+
|
|
15
|
+
- [<page title>](<path to the page>)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Tutorial: <Verb and what the reader builds>
|
|
2
|
+
|
|
3
|
+
<What the reader builds, and what they learn on the way.>
|
|
4
|
+
|
|
5
|
+
## Before you begin
|
|
6
|
+
|
|
7
|
+
- <each prerequisite, with the version it is tested on>
|
|
8
|
+
|
|
9
|
+
## <Step, verb first>
|
|
10
|
+
|
|
11
|
+
To <do the task>:
|
|
12
|
+
|
|
13
|
+
1. <step>
|
|
14
|
+
1. <step>
|
|
15
|
+
|
|
16
|
+
<What the reader sees now.>
|
|
17
|
+
|
|
18
|
+
## Troubleshooting
|
|
19
|
+
|
|
20
|
+
<Leave this section out when no reader has met a failure worth naming yet.>
|
|
21
|
+
|
|
22
|
+
### <The symptom, or the error text>
|
|
23
|
+
|
|
24
|
+
<The cause.>
|
|
25
|
+
<The resolution.>
|
|
26
|
+
|
|
27
|
+
## Related topics
|
|
28
|
+
|
|
29
|
+
<Leave this section out when there is no other page to send the reader to.>
|
|
30
|
+
|
|
31
|
+
- [<page title>](<path to the page>)
|