@simpleapps-com/augur-skills 2026.3.18 → 2026.3.20
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/package.json
CHANGED
|
@@ -13,18 +13,18 @@ Shared npm packages for Next.js ecommerce sites and React Native apps. Published
|
|
|
13
13
|
|
|
14
14
|
Before writing custom code, check whether a package export already solves the problem.
|
|
15
15
|
|
|
16
|
-
## Ground Truth: Read the
|
|
16
|
+
## Ground Truth: Read the Docs
|
|
17
17
|
|
|
18
18
|
This skill is a **stub, not an archive**. New packages are created, existing packages gain features, APIs evolve. This skill MUST NOT be treated as the complete picture.
|
|
19
19
|
|
|
20
|
-
**Always read the installed packages in
|
|
20
|
+
**Always read the installed packages' documentation in `node_modules/`:**
|
|
21
21
|
|
|
22
22
|
1. Use `Glob("repo/node_modules/@simpleapps-com/*")` to discover ALL available packages — there may be packages not listed here
|
|
23
|
-
2. Read `repo/node_modules/@simpleapps-com/<package>/
|
|
24
|
-
3. Read
|
|
25
|
-
4.
|
|
23
|
+
2. Read `repo/node_modules/@simpleapps-com/<package>/llms.txt` — machine-readable, lists every export with descriptions and usage examples. This is the fastest path to discovering what exists.
|
|
24
|
+
3. Read `repo/node_modules/@simpleapps-com/<package>/README.md` for full API docs, code examples, and "Replaces" guidance
|
|
25
|
+
4. MUST NOT read `dist/`, `.d.ts`, or compiled JS files to discover capabilities — they are minified, chunked, and incomplete. The README and llms.txt are the source of truth.
|
|
26
26
|
|
|
27
|
-
When this skill and the installed
|
|
27
|
+
When this skill and the installed docs disagree, **the installed docs win**. This skill exists to point you in the right direction, not to replace reading the docs.
|
|
28
28
|
|
|
29
29
|
## Known Packages
|
|
30
30
|
|
|
@@ -40,13 +40,37 @@ These are starting hints — not a complete list. Always check `node_modules/@si
|
|
|
40
40
|
|
|
41
41
|
## How to Check for Package Solutions
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
MUST follow this procedure before writing custom code or filing a package issue:
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
45
|
+
### Step 1: Read llms.txt
|
|
46
|
+
|
|
47
|
+
For each installed `@simpleapps-com/augur-*` package, read its `llms.txt`:
|
|
48
|
+
```
|
|
49
|
+
Read("repo/node_modules/@simpleapps-com/<package>/llms.txt")
|
|
50
|
+
```
|
|
51
|
+
This lists every export with descriptions and usage examples.
|
|
52
|
+
|
|
53
|
+
### Step 2: Read README.md for details
|
|
54
|
+
|
|
55
|
+
If llms.txt shows a relevant export, read the README for full API, code examples, and "Replaces" guidance showing what site code it eliminates.
|
|
56
|
+
|
|
57
|
+
### Step 3: MUST NOT grep compiled output
|
|
58
|
+
|
|
59
|
+
MUST NOT read or grep `dist/`, `.d.ts`, `.js`, or any compiled files to discover package capabilities. These are minified build artifacts — unreliable for discovery. The README and llms.txt are the ONLY source of truth.
|
|
60
|
+
|
|
61
|
+
### Step 4: Before filing a package issue
|
|
62
|
+
|
|
63
|
+
Before creating an issue on `simpleapps-com/augur-packages` requesting a new feature:
|
|
64
|
+
1. Search ALL package llms.txt files for the function/hook name
|
|
65
|
+
2. Search ALL package README.md files for the concept
|
|
66
|
+
3. If found, the problem is site adoption — not a package gap. Use the existing export.
|
|
67
|
+
|
|
68
|
+
### Step 5: Before writing custom code
|
|
69
|
+
|
|
70
|
+
Before creating a custom hook, utility, or action in a site:
|
|
71
|
+
1. Search ALL package llms.txt files for similar functionality
|
|
72
|
+
2. Check the augur-hooks README "Examples" section for the pattern
|
|
73
|
+
3. If a package export exists, use it. If it does not work as expected, file a bug on the package — not a reimplementation in the site.
|
|
50
74
|
|
|
51
75
|
## What Stays Site-Specific
|
|
52
76
|
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: deployment
|
|
3
|
+
description: Project deployment conventions — reads the wiki Deployment page and executes submit, deploy, or publish steps. Refuses to operate without a Deployment page.
|
|
4
|
+
user-invocable: false
|
|
5
|
+
allowed-tools:
|
|
6
|
+
- Read
|
|
7
|
+
- Glob
|
|
8
|
+
- Grep
|
|
9
|
+
- Bash
|
|
10
|
+
- Skill(git-safety)
|
|
11
|
+
- Skill(conventional-commits)
|
|
12
|
+
- Skill(github)
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
First, use Skill("git-safety") to load git guardrails.
|
|
16
|
+
|
|
17
|
+
# Deployment
|
|
18
|
+
|
|
19
|
+
This skill reads the project's `wiki/Deployment.md` and executes the steps defined there. Each project defines its own deployment workflow — this skill is the executor, the wiki is the config.
|
|
20
|
+
|
|
21
|
+
## Deployment Page Format
|
|
22
|
+
|
|
23
|
+
Every project wiki SHOULD have a `Deployment.md` page with up to three sections:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
## Submit
|
|
27
|
+
How to commit and create a PR for review.
|
|
28
|
+
|
|
29
|
+
## Deploy
|
|
30
|
+
How to deploy to staging.
|
|
31
|
+
|
|
32
|
+
## Publish
|
|
33
|
+
How to release to production.
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Not all projects need all three. Client sites may only have Submit and Deploy. Package repos may have all three.
|
|
37
|
+
|
|
38
|
+
## How It Works
|
|
39
|
+
|
|
40
|
+
1. Read `wiki/Deployment.md`
|
|
41
|
+
2. Find the section matching the requested action (Submit, Deploy, or Publish)
|
|
42
|
+
3. If the page or section is missing, **refuse to operate** — tell the user to run `/curate-wiki` to generate it
|
|
43
|
+
4. Execute the steps in that section, respecting git-safety at every git write operation
|
|
44
|
+
|
|
45
|
+
## Guard Rails
|
|
46
|
+
|
|
47
|
+
- MUST NOT guess deployment steps — only execute what the wiki defines
|
|
48
|
+
- MUST NOT operate if the Deployment page is missing or the relevant section is absent
|
|
49
|
+
- MUST load git-safety — every git write operation requires user approval
|
|
50
|
+
- `/publish` MUST complete the verification gate before executing (see below)
|
|
51
|
+
|
|
52
|
+
## Publish Verification Gate
|
|
53
|
+
|
|
54
|
+
Before executing any Publish steps, MUST:
|
|
55
|
+
|
|
56
|
+
1. Show the **current version** and the **proposed new version**
|
|
57
|
+
2. Show **what changes** are included since the last release (`git log` from last tag)
|
|
58
|
+
3. Show **CI/test status** if available (`gh run list` or local test run)
|
|
59
|
+
4. Present a summary: version transition, commit count, test status
|
|
60
|
+
5. Require the user to **explicitly confirm** the specific version going to production
|
|
61
|
+
|
|
62
|
+
This is not just git-safety. It is an active verification checklist — the user MUST see exactly what they are releasing and confirm that specific version.
|
|
@@ -124,6 +124,10 @@ The wikis are kept fresh by `/curate-wiki` runs across projects. Searching local
|
|
|
124
124
|
|
|
125
125
|
**What to search for:** testing patterns and checklists, architecture decisions, coding conventions, deployment procedures, and how specific features were implemented. Other sites have already solved many of the same problems — search before building from scratch.
|
|
126
126
|
|
|
127
|
+
## Deployment Page
|
|
128
|
+
|
|
129
|
+
Every project wiki SHOULD have a `Deployment.md` page with up to three sections: Submit, Deploy, and Publish. This page defines the project-specific steps that `/submit`, `/deploy`, and `/publish` commands execute. Run `/curate-wiki` to generate it from the codebase — the command scans CI workflows, package.json, deploy scripts, and asks the user about anything it cannot determine. See the `deployment` skill for the expected format.
|
|
130
|
+
|
|
127
131
|
## Testing Page
|
|
128
132
|
|
|
129
133
|
Every project wiki SHOULD have a `Testing.md` page. This is the E2E verification checklist that `/verify` uses to walk through the site in Chrome. The page grows over time — `/curate-wiki` SHOULD add testing knowledge learned during the session (new edge cases, failure patterns, test data) to the Testing page.
|
|
@@ -69,7 +69,7 @@ gh issue create --repo simpleapps-com/<repo> \
|
|
|
69
69
|
The full workflow from task to delivery, each step feeding the next:
|
|
70
70
|
|
|
71
71
|
```
|
|
72
|
-
/triage → /wip → /investigate → /discuss → /implement → /quality → /verify → /
|
|
72
|
+
/triage → /wip → /investigate → /discuss → /implement → /quality → /verify → /submit → /deploy → /publish
|
|
73
73
|
```
|
|
74
74
|
|
|
75
75
|
| Phase | Command | What happens |
|
|
@@ -81,9 +81,13 @@ The full workflow from task to delivery, each step feeding the next:
|
|
|
81
81
|
| Build | `/implement` | Execute the plan — code changes only, no commits |
|
|
82
82
|
| Code checks | `/quality` | Lint, typecheck, test, package freshness |
|
|
83
83
|
| Browser checks | `/verify` | Walk through wiki's Testing.md checklist in Chrome |
|
|
84
|
-
|
|
|
84
|
+
| Submit | `/submit` | Commit and create a PR for review |
|
|
85
|
+
| Stage | `/deploy` | Deploy to staging (merge PRs, trigger staging build) |
|
|
86
|
+
| Release | `/publish` | Version bump, tag, release to production (with verification) |
|
|
85
87
|
|
|
86
|
-
|
|
88
|
+
Not every task uses all steps. Most daily work ends at `/submit`. `/deploy` and `/publish` are used less frequently — `/publish` is intentionally rare and requires explicit verification of the exact version going to production.
|
|
89
|
+
|
|
90
|
+
The three shipping commands (`/submit`, `/deploy`, `/publish`) read project-specific steps from `wiki/Deployment.md`. They refuse to operate if the Deployment page is missing — run `/curate-wiki` to generate it from the codebase.
|
|
87
91
|
|
|
88
92
|
Commands like `/research` and `/discuss` can be used at any stage. `/quality`, `/verify`, `/curate-wiki`, and `/wiki-audit` can run independently.
|
|
89
93
|
|
|
@@ -60,6 +60,14 @@ Every token costs time, money, and cognitive load. Be concise without losing cla
|
|
|
60
60
|
|
|
61
61
|
Default to brief. Expand only when the reader cannot infer meaning from context. Two sentences that answer the question beat two pages that fill the context window.
|
|
62
62
|
|
|
63
|
+
## Code Style
|
|
64
|
+
|
|
65
|
+
Use descriptive variable and function names. Abbreviations save keystrokes but cost readability — the human reviewing your output MUST be able to understand the code without deciphering names.
|
|
66
|
+
|
|
67
|
+
- MUST use full words: `$groupQuantity` not `$gq`, `cartItem` not `ci`
|
|
68
|
+
- Loop counters (`i`, `j`, `k`) and well-known abbreviations (`id`, `url`, `db`) are fine
|
|
69
|
+
- Function names SHOULD describe what they do: `calculateShippingCost` not `calcShip`
|
|
70
|
+
|
|
63
71
|
## Claude Code Keywords
|
|
64
72
|
|
|
65
73
|
Thinking trigger words (`think`, `think hard`, `ultrathink`) are deprecated. Extended thinking is on by default. Use `/effort` (low/medium/high/max) for control.
|