telo3-ai 5.0.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/AI-CONTEXT.md +263 -0
- package/LICENSE +21 -0
- package/ONBOARDING-SKILL.md +728 -0
- package/README.md +801 -0
- package/SKILL-METADATA.json +237 -0
- package/SKILL.md +666 -0
- package/cli.js +84 -0
- package/index.js +65 -0
- package/package.json +97 -0
- package/references/accessibility-quality.md +278 -0
- package/references/ai-behavior.md +363 -0
- package/references/document-specification.md +425 -0
- package/references/legal-compliance.md +408 -0
- package/references/performance-quality.md +351 -0
- package/references/privacy-compliance.md +494 -0
- package/references/project-audit.md +468 -0
- package/references/security-quality.md +254 -0
- package/references/seo-quality.md +347 -0
- package/references/smart-skill-delegation.md +451 -0
- package/references/token-optimization.md +481 -0
- package/references/ui-quality.md +491 -0
- package/references/workflow.md +474 -0
- package/scripts/init-project-context.sh +139 -0
- package/scripts/validate-project-context.sh +164 -0
- package/templates/architecture.md +418 -0
- package/templates/design.md +654 -0
- package/templates/memory.md +368 -0
- package/templates/prd.md +320 -0
- package/templates/rules.md +619 -0
- package/templates/tasks.md +220 -0
package/AI-CONTEXT.md
ADDED
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
# AI Context — Quick Reference
|
|
2
|
+
|
|
3
|
+
> **Ultra-concise project context for AI agents. Read this FIRST (30 seconds).**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## What This Is
|
|
8
|
+
|
|
9
|
+
**Project Context System** = 6 documents + quality frameworks for systematic AI coding.
|
|
10
|
+
|
|
11
|
+
Prevents: vibe coding, architectural drift, forgotten decisions, security mistakes.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Core Documents (Read Selectively)
|
|
16
|
+
|
|
17
|
+
| File | When to Read | Time |
|
|
18
|
+
|------|--------------|------|
|
|
19
|
+
| **memory.md** | ALWAYS (current state) | 30s |
|
|
20
|
+
| **prd.md** | Changing requirements | 2min |
|
|
21
|
+
| **architecture.md** | Adding features, structure changes | 3min |
|
|
22
|
+
| **rules.md** | Unsure about standards | 2min |
|
|
23
|
+
| **design.md** | Building UI | 2min |
|
|
24
|
+
| **tasks.md** | Planning work | 1min |
|
|
25
|
+
|
|
26
|
+
**Default:** Read memory.md only. Load others if relevant.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Quick Decision Framework
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
Tiny task (< 5min)?
|
|
34
|
+
→ Read affected file only → Code → Update memory.md
|
|
35
|
+
|
|
36
|
+
Medium task (5-15min)?
|
|
37
|
+
→ Read memory.md + relevant doc → Code → Update 2 docs
|
|
38
|
+
|
|
39
|
+
Large task (15min+)?
|
|
40
|
+
→ Read context subset → Plan → Code → Update all affected
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Critical Rules
|
|
46
|
+
|
|
47
|
+
### Security (Non-Negotiable)
|
|
48
|
+
- Validate ALL user input
|
|
49
|
+
- Check authorization on EVERY request
|
|
50
|
+
- Never commit secrets
|
|
51
|
+
- Hash passwords (bcrypt/argon2)
|
|
52
|
+
- Filter queries by teamId/userId (if multi-tenant)
|
|
53
|
+
|
|
54
|
+
### Privacy (Required)
|
|
55
|
+
- Document data collection
|
|
56
|
+
- Self-host fonts (no Google Fonts by default)
|
|
57
|
+
- No invasive tracking without disclosure
|
|
58
|
+
- Support data deletion
|
|
59
|
+
|
|
60
|
+
### Legal (Awareness)
|
|
61
|
+
- Age restrictions if children can use service
|
|
62
|
+
- Unsubscribe for marketing emails
|
|
63
|
+
- Clear subscription terms
|
|
64
|
+
- DMCA agent for user content (U.S.)
|
|
65
|
+
- **This is engineering guidance, not legal advice**
|
|
66
|
+
|
|
67
|
+
### Quality (Standards)
|
|
68
|
+
- Follow existing patterns (inspect before creating)
|
|
69
|
+
- Reuse components (don't duplicate)
|
|
70
|
+
- Accessible by default (semantic HTML, ARIA, contrast)
|
|
71
|
+
- Responsive (mobile-first)
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Token Optimization
|
|
76
|
+
|
|
77
|
+
### Read Minimum
|
|
78
|
+
- memory.md (always)
|
|
79
|
+
- Affected files only
|
|
80
|
+
- Skip unrelated code
|
|
81
|
+
|
|
82
|
+
### Skip Unnecessary
|
|
83
|
+
- Don't test if not requested
|
|
84
|
+
- Don't verify unchanged code
|
|
85
|
+
- Don't inspect unrelated files
|
|
86
|
+
- Don't re-read files from this conversation
|
|
87
|
+
|
|
88
|
+
### Communicate Concisely
|
|
89
|
+
**Normal mode:** Brief, clear updates
|
|
90
|
+
**Caveman mode:** Ultra-short, no fluff
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Smart Delegation
|
|
95
|
+
|
|
96
|
+
**Before implementing, check:**
|
|
97
|
+
- Does skill exist for this? (check your AI's skills directory)
|
|
98
|
+
- Is there MCP tool? (figma, context7, stripe, etc.)
|
|
99
|
+
- Would sub-agent do better? (if your AI supports delegation)
|
|
100
|
+
|
|
101
|
+
**Use specialized tools for specialized tasks.**
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Update Pattern
|
|
106
|
+
|
|
107
|
+
**After EVERY meaningful change:**
|
|
108
|
+
|
|
109
|
+
✅ Update **memory.md** (current state, decisions)
|
|
110
|
+
✅ Update **tasks.md** (mark complete, add new)
|
|
111
|
+
✅ Update other docs ONLY if they changed
|
|
112
|
+
|
|
113
|
+
❌ Don't update unrelated docs
|
|
114
|
+
❌ Don't duplicate info across docs
|
|
115
|
+
❌ Don't turn memory.md into conversation log
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Quality Checks (Mental)
|
|
120
|
+
|
|
121
|
+
Before marking complete:
|
|
122
|
+
- [ ] Follows existing patterns?
|
|
123
|
+
- [ ] Security considered?
|
|
124
|
+
- [ ] Accessible (if UI)?
|
|
125
|
+
- [ ] Documentation updated?
|
|
126
|
+
- [ ] No secrets committed?
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Caveman Mode
|
|
131
|
+
|
|
132
|
+
**User says:** "caveman mode" or "be concise"
|
|
133
|
+
|
|
134
|
+
**You respond:**
|
|
135
|
+
```
|
|
136
|
+
Caveman mode ON.
|
|
137
|
+
Short responses.
|
|
138
|
+
Ready.
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
**Format:**
|
|
142
|
+
- Short sentences
|
|
143
|
+
- No fluff
|
|
144
|
+
- Facts only
|
|
145
|
+
- Action → Result → Done
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## Response Templates
|
|
150
|
+
|
|
151
|
+
### Standard Update
|
|
152
|
+
```
|
|
153
|
+
Task: [X]
|
|
154
|
+
|
|
155
|
+
Changed:
|
|
156
|
+
- file.ts (added Y)
|
|
157
|
+
- file2.ts (updated Z)
|
|
158
|
+
|
|
159
|
+
Updated:
|
|
160
|
+
- memory.md
|
|
161
|
+
- tasks.md
|
|
162
|
+
|
|
163
|
+
Done.
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Caveman Update
|
|
167
|
+
```
|
|
168
|
+
Done.
|
|
169
|
+
|
|
170
|
+
Changed:
|
|
171
|
+
- file.ts (Y)
|
|
172
|
+
- file2.ts (Z)
|
|
173
|
+
|
|
174
|
+
Docs current.
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Bug Fix
|
|
178
|
+
```
|
|
179
|
+
Fixed [issue].
|
|
180
|
+
|
|
181
|
+
Root cause: [X]
|
|
182
|
+
Changed: [file:line]
|
|
183
|
+
Verified: Works now.
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## When to Ask User
|
|
189
|
+
|
|
190
|
+
**Ask when:**
|
|
191
|
+
- Requirements unclear
|
|
192
|
+
- Multiple valid approaches
|
|
193
|
+
- Breaking change needed
|
|
194
|
+
- Security/privacy decision
|
|
195
|
+
- Scope change
|
|
196
|
+
|
|
197
|
+
**Don't ask when:**
|
|
198
|
+
- Obvious implementation
|
|
199
|
+
- Following existing pattern
|
|
200
|
+
- Standard practice
|
|
201
|
+
- Documented in context
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
## Common Patterns (Auto-Apply)
|
|
206
|
+
|
|
207
|
+
| User Request | Auto Action |
|
|
208
|
+
|--------------|-------------|
|
|
209
|
+
| "Fix typo" | Fix → No test → Update memory.md |
|
|
210
|
+
| "Change color" | Check design.md → Update → Done |
|
|
211
|
+
| "Add form field" | Add with validation → Test if critical |
|
|
212
|
+
| "Update docs" | Update → No code verification |
|
|
213
|
+
| "Refactor" | Read code → Plan → Confirm → Refactor |
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Reference Docs (Load as Needed)
|
|
218
|
+
|
|
219
|
+
**Quality frameworks in `references/`:**
|
|
220
|
+
- `ui-quality.md` — Anti-vibe-coding
|
|
221
|
+
- `seo-quality.md` — SEO audit
|
|
222
|
+
- `accessibility-quality.md` — WCAG standards
|
|
223
|
+
- `performance-quality.md` — Core Web Vitals
|
|
224
|
+
- `security-quality.md` — Security audit
|
|
225
|
+
- `privacy-compliance.md` — Privacy guidelines
|
|
226
|
+
- `legal-compliance.md` — Compliance awareness
|
|
227
|
+
- `token-optimization.md` — Efficiency rules
|
|
228
|
+
- `smart-skill-delegation.md` — Use other tools
|
|
229
|
+
|
|
230
|
+
**Load only when doing that type of work.**
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## Skill Location
|
|
235
|
+
|
|
236
|
+
This skill: Anywhere you cloned Telo3 (universal)
|
|
237
|
+
|
|
238
|
+
Main instruction: `SKILL.md`
|
|
239
|
+
Templates: `templates/`
|
|
240
|
+
References: `references/`
|
|
241
|
+
Scripts: `scripts/`
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Summary (10 seconds)
|
|
246
|
+
|
|
247
|
+
1. **Read memory.md first** (30s)
|
|
248
|
+
2. **Load relevant context only**
|
|
249
|
+
3. **Follow existing patterns**
|
|
250
|
+
4. **Code with security/privacy/quality**
|
|
251
|
+
5. **Update memory.md + tasks.md**
|
|
252
|
+
6. **Communicate concisely**
|
|
253
|
+
7. **Use specialized tools when better**
|
|
254
|
+
|
|
255
|
+
**Goal:** Systematic engineering. Minimal tokens. Maximum quality.
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
**Now check memory.md for current project state.**
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
**Telo3 by [Jeet](https://github.com/Jeet1511)** | [Full Docs](https://github.com/Jeet1511/telo3) | [Contribute](https://github.com/Jeet1511/telo3/blob/main/CONTRIBUTING.md)
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Project Context System Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|