@clipboard-health/ai-rules 1.6.16 → 1.6.17
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 +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,9 @@ npm install --save-dev @clipboard-health/ai-rules
|
|
|
22
22
|
|
|
23
23
|
### Quick Start
|
|
24
24
|
|
|
25
|
-
1.
|
|
25
|
+
1. If you have an existing `AGENTS.md` and/or `CLAUDE.md` file in your repository, rename it to `OVERLAY.md`. The `sync-ai-rules` script you'll add below appends this file's contents to each generated file so it's loaded into LLM agent contexts.
|
|
26
|
+
|
|
27
|
+
2. Choose the profile that matches your project type:
|
|
26
28
|
|
|
27
29
|
| Profile | Includes | Use For |
|
|
28
30
|
| -------------- | --------------------------- | -------------------------------------- |
|
|
@@ -38,7 +40,7 @@ npm install --save-dev @clipboard-health/ai-rules
|
|
|
38
40
|
- **backend**: NestJS APIs, three-tier architecture, controllers, services
|
|
39
41
|
- **datamodeling**: data modeling, testing, yaml documentation, data cleaning, analytics
|
|
40
42
|
|
|
41
|
-
|
|
43
|
+
3. Add it to your `package.json`:
|
|
42
44
|
|
|
43
45
|
```json
|
|
44
46
|
{
|
|
@@ -49,21 +51,19 @@ npm install --save-dev @clipboard-health/ai-rules
|
|
|
49
51
|
}
|
|
50
52
|
```
|
|
51
53
|
|
|
52
|
-
|
|
54
|
+
4. Run:
|
|
53
55
|
|
|
54
56
|
```bash
|
|
55
57
|
npm install # Runs postinstall automatically
|
|
56
58
|
```
|
|
57
59
|
|
|
58
|
-
|
|
60
|
+
5. Commit the generated files:
|
|
59
61
|
|
|
60
62
|
```bash
|
|
61
63
|
git add .
|
|
62
64
|
git commit -m "feat: add AI coding rules"
|
|
63
65
|
```
|
|
64
66
|
|
|
65
|
-
5. Bonus: For repo-specific rules, create an `OVERLAY.md` file. The `sync` script appends its contents in each generated file to load the contents into AI agent context.
|
|
66
|
-
|
|
67
67
|
### Updating Rules
|
|
68
68
|
|
|
69
69
|
When we release new rules or improvements:
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clipboard-health/ai-rules",
|
|
3
3
|
"description": "Pre-built AI agent rules for consistent coding standards.",
|
|
4
|
-
"version": "1.6.
|
|
4
|
+
"version": "1.6.17",
|
|
5
5
|
"bugs": "https://github.com/ClipboardHealth/core-utils/issues",
|
|
6
6
|
"devDependencies": {
|
|
7
7
|
"@intellectronica/ruler": "0.3.21"
|