Skip to content

Commit 5870d2e

Browse files
committed
docs: add update system recommendation protocol
1 parent e3561c8 commit 5870d2e

31 files changed

Lines changed: 810 additions & 581 deletions

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ labels:
66
body:
77
- type: markdown
88
attributes:
9-
value: |
10-
Thanks for helping improve Nexus-APCP. Do not include secrets, private project context, generated private prompt bundles, or exploit details.
9+
value: | Thanks for helping improve Nexus-APCP. Do not include secrets, private project context, generated private prompt bundles, or exploit details.
1110
- type: textarea
1211
id: problem
1312
attributes:
@@ -21,8 +20,7 @@ body:
2120
attributes:
2221
label: Steps to reproduce
2322
description: List the exact command, file, or section involved.
24-
placeholder: |
25-
1. Open ...
23+
placeholder: | 1. Open ...
2624
2. Run ...
2725
3. See ...
2826
- type: textarea

.github/ISSUE_TEMPLATE/security_private.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ labels:
66
body:
77
- type: markdown
88
attributes:
9-
value: |
10-
If this is a vulnerability report, do not continue here. Use GitHub private vulnerability reporting if available, or request a private contact without sharing details.
9+
value: | If this is a vulnerability report, do not continue here. Use GitHub private vulnerability reporting if available, or request a private contact without sharing details.
1110
- type: textarea
1211
id: safe_summary
1312
attributes:

.github/pull_request_title_conventions.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,15 @@ fix(script): Handle Unicode output on Windows
1717
chore(metadata): Refresh repository SEO topics
1818
```
1919

20-
## Types
21-
22-
| Type | Use for |
20+
## Types | Type | Use for |
2321
| :--- | :--- |
2422
| `feat` | New protocol capabilities, example kits, or user-facing assets. |
2523
| `fix` | Corrections to broken links, scripts, incorrect guidance, or unsafe defaults. |
2624
| `docs` | Documentation-only changes. |
2725
| `prompt` | Prompt templates, AI instructions, or agent guidance. |
2826
| `security` | Safe-publishing guidance, private-context handling, or vulnerability-reporting process. |
2927
| `ci` | GitHub Actions or repository validation automation. |
30-
| `chore` | Metadata, maintenance, cleanup, or non-user-facing updates. |
31-
32-
## Scopes
28+
| `chore` | Metadata, maintenance, cleanup, or non-user-facing updates. | ## Scopes
3329

3430
Common scopes include `readme`, `protocol`, `prompts`, `security`, `seo`, `examples`, `scripts`, `github`, and `agents`.
3531

AGENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The public repository should remain safe to share. Real project context files, p
1919
| `DECISION_LOG_PROTOCOL.md` | Decision history and architecture intent protocol. |
2020
| `CONTEXT_OPTIMIZATION.md` | Strategies for handling large-scale codebases and context window limits. |
2121
| `CAVEMAN_RULES.md` | Token-efficient communication rules. |
22+
| `EMOJI_POLICY.md` | Repository-wide and AI-wide emoji usage ban with a narrow user-approved temporary button icon exception. |
2223
| `AI_ASSISTANT_PROMPT_TEMPLATES.md` | Reusable prompts for common AI-assisted development scenarios. |
2324
| `WORKSPACE_SPECIFIC_DELIVERY_PROTOCOLS.md` | Domain-specific delivery gates and release expectations. |
2425
| `DOMAIN_SPECIFIC_GITIGNORE_PROTOCOLS.md` | Safe publishing patterns for different project domains. |
@@ -49,6 +50,7 @@ powershell -ExecutionPolicy Bypass -File scripts/checkpoint.ps1
4950
- Preserve the public/private boundary. Public templates are welcome; filled private project context is not.
5051
- Prefer durable wording over model-version-specific wording.
5152
- Keep repository-facing terminology consistent: `Nexus-APCP`, `AI Project Context Protocol`, `context engineering`, `AI-assisted development`, and `token optimization`.
53+
- Follow `EMOJI_POLICY.md`: do not add emoji to README files, Markdown, code, comments, scripts, metadata, examples, generated output, commits, PR text, or AI responses. For a missing button icon, ask the user before using a temporary emoji placeholder.
5254
- Update `TASK_PROGRESS.yaml` when completing a visible repository maintenance task.
5355
- Update `docs/SEO_CHECKLIST.md`, `codemeta.json`, or `.github/repository-metadata.yml` when changing search-facing positioning.
5456
- Use concise comments only when they explain non-obvious validation, safety, or release behavior.

AI_ASSISTANT_PROMPT_TEMPLATES.md

Lines changed: 64 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# 🤖 Nexus-APCP AI Assistant Prompt Templates
1+
# Nexus-APCP AI Assistant Prompt Templates
22
## Ready-to-use prompts for AI-assisted development scenarios
33

44
---
55

6-
## 📌 SCENARIO 0: Initializing the "Second Brain" (NotebookLM / Obsidian Sync)
6+
## SCENARIO 0: Initializing the "Second Brain" (NotebookLM / Obsidian Sync)
77
**Objective:** Transform structured APCP context into a high-density Knowledge Base optimized for RAG-based tools (NotebookLM) or linked-note systems (Obsidian). This is critical for team onboarding and multi-model synchronization.
88

99
**Prompt to send to AI:**
@@ -23,7 +23,7 @@ Format the output to be instructive and mentor-like, ensuring all technical term
2323

2424
---
2525

26-
## 📌 SCENARIO 1: Starting a Project for the First Time (Recommended)
26+
## SCENARIO 1: Starting a Project for the First Time (Recommended)
2727

2828
Copy and send to the AI in the same session:
2929

@@ -52,7 +52,7 @@ Let's make sure we're on the same page before diving into code.
5252

5353
---
5454

55-
## 📌 SCENARIO 2: Continuing with the Same Model
55+
## SCENARIO 2: Continuing with the Same Model
5656

5757
If you are close to the token limit and continuing with the same model:
5858

@@ -76,7 +76,7 @@ Let's go!
7676

7777
---
7878

79-
## 📌 SCENARIO 3: Switching to a New Model
79+
## SCENARIO 3: Switching to a New Model
8080

8181
If you are changing models or have reached the token limit:
8282

@@ -102,7 +102,7 @@ We'll continue exactly where we left off.
102102

103103
---
104104

105-
## 📌 SCENARIO 4: Code Review Session
105+
## SCENARIO 4: Code Review Session
106106

107107
To review existing code:
108108

@@ -124,15 +124,15 @@ Please review against:
124124
4. Section 15 (Code Review Checklist)
125125
126126
Give me:
127-
- What looks good
128-
- ⚠️ Issues/concerns
129-
- 🔧 Suggested improvements
130-
- 📝 Before you approve, I'll:
127+
- What looks good
128+
- Issues/concerns
129+
- Suggested improvements
130+
- Before you approve, I'll:
131131
```
132132

133133
---
134134

135-
## 📌 SCENARIO 5: Editing Documentation
135+
## SCENARIO 5: Editing Documentation
136136

137137
When documentation needs updating:
138138

@@ -161,7 +161,7 @@ Draft the documentation for me.
161161

162162
---
163163

164-
## 📌 SCENARIO 6: Bug Fix / Hotfix
164+
## SCENARIO 6: Bug Fix / Hotfix
165165

166166
When an urgent bug fix is needed:
167167

@@ -187,7 +187,7 @@ Let's move fast but safe.
187187

188188
---
189189

190-
## 📌 SCENARIO 7: Architecture Decision
190+
## SCENARIO 7: Architecture Decision
191191

192192
When an architectural decision or refactoring is needed:
193193

@@ -214,7 +214,7 @@ Let's think this through before we code.
214214

215215
---
216216

217-
## 📌 SCENARIO 8: Performance Optimization
217+
## SCENARIO 8: Performance Optimization
218218

219219
When performance improvement is needed:
220220

@@ -244,7 +244,7 @@ Let's make it faster.
244244

245245
---
246246

247-
## 📌 SCENARIO 9: Dependency/Library Update
247+
## SCENARIO 9: Dependency/Library Update
248248

249249
When updating a library or adding a new dependency:
250250

@@ -271,7 +271,7 @@ Help me make this update safely.
271271

272272
---
273273

274-
## 📌 SCENARIO 10: Task Not Started Yet
274+
## SCENARIO 10: Task Not Started Yet
275275

276276
Time to start a new task:
277277

@@ -301,7 +301,7 @@ Let's build this feature!
301301

302302
---
303303

304-
## 🔗 SCENARIO 11: External Service Integration
304+
## SCENARIO 11: External Service Integration
305305

306306
Integrating an external service/API:
307307

@@ -334,7 +334,7 @@ Let's integrate this safely.
334334

335335
---
336336

337-
## 🚀 SCENARIO 12: Deployment Preparation
337+
## SCENARIO 12: Deployment Preparation
338338

339339
Before production deployment:
340340

@@ -365,12 +365,12 @@ Ready to deploy?
365365

366366
---
367367

368-
## 🆘 SCENARIO 13: Emergency / Urgent Issue
368+
## SCENARIO 13: Emergency / Urgent Issue
369369

370370
Solving an emergency:
371371

372372
```
373-
🚨 EMERGENCY FIX NEEDED 🚨
373+
EMERGENCY FIX NEEDED
374374
375375
Issue: [Description]
376376
Severity: [Critical / High / Medium]
@@ -396,7 +396,7 @@ Let's fix this NOW.
396396

397397
---
398398

399-
## 📊 SCENARIO 14: Retrospective & Planning
399+
## SCENARIO 14: Retrospective & Planning
400400

401401
Retrospective and planning at the end of a sprint:
402402

@@ -429,7 +429,7 @@ Ready for next sprint planning.
429429

430430
---
431431

432-
## 🔄 SCENARIO 15: Token/Session Ending
432+
## SCENARIO 15: Token/Session Ending
433433

434434
If you are approaching the end of the session:
435435

@@ -454,7 +454,7 @@ Please:
454454
455455
456456
2. Update TASK_PROGRESS.yaml:
457-
- Mark completed tasks as
457+
- Mark completed tasks as
458458
- Update in-progress percentages
459459
- Note blockers for next session
460460
@@ -470,7 +470,7 @@ Save everything and ready to switch models.
470470
471471
---
472472
473-
## 📌 SCENARIO 16: Caveman Mode (Token Saver) 🪨
473+
## SCENARIO 16: Caveman Mode (Token Saver)
474474
475475
Use this to reduce output token usage by 65%+:
476476
@@ -491,9 +491,40 @@ Why use many token when few token do trick?
491491

492492
---
493493

494-
## 📝 BEST PRACTICES WHEN USING THESE PROMPTS
494+
## SCENARIO 17: User-Requested Update System
495495

496-
### ✅ DOS
496+
Use this only when the user asks for an updater, version checker, auto-update flow, GitHub sync, or launcher that updates before app start.
497+
498+
```
499+
I want an update system for [PROJECT_NAME].
500+
501+
User request:
502+
[Describe the requested update behavior]
503+
504+
Project profile:
505+
- Runtime target: [Windows desktop / portable app / web app / SaaS / mobile / other]
506+
- Distribution source: [public GitHub / private repo / package manager / app store / other]
507+
- Current launch flow: [start.bat / start.ps1 / app.exe / npm script / other]
508+
- Versioning: [SemVer / tags / releases / none]
509+
- Local-only files to protect: [.env, user data, settings, generated files, private context]
510+
511+
Context:
512+
[PASTE: UPDATE_SYSTEM_RECOMMENDATION_PROTOCOL.md]
513+
[PASTE: AI_PROJECT_CONTEXT_PROTOCOL.md - Sections 4, 6, 13 only]
514+
515+
Please:
516+
1. Decide whether the Archura SyncGuard style pattern fits.
517+
2. If it fits, propose the safest implementation plan and required files.
518+
3. If values are missing, inspect the repository first and propose defaults.
519+
4. If it does not fit, recommend the correct release/update strategy instead.
520+
5. Preserve private files, local settings, backups, logs, and generated prompt bundles.
521+
```
522+
523+
---
524+
525+
## BEST PRACTICES WHEN USING THESE PROMPTS
526+
527+
### DOS
497528

498529
1. **Always copy files in full**:
499530
Instead of:
@@ -508,13 +539,13 @@ Why use many token when few token do trick?
508539

509540
3. **Be specific** (avoid vague requests):
510541
```
511-
Bad: "Help me with the API"
512-
Good: "Help me implement GET /users/{id} endpoint with proper error handling"
542+
Bad: "Help me with the API"
543+
Good: "Help me implement GET /users/{id} endpoint with proper error handling"
513544
```
514545

515546
4. **Always update TASK_PROGRESS**:
516547
At the end of the session:
517-
- Mark completed tasks with
548+
- Mark completed tasks with
518549
- Update in-progress (%)
519550
- Add actual effort
520551
- Note blockers
@@ -525,7 +556,7 @@ Why use many token when few token do trick?
525556
```
526557
Right before committing.
527558

528-
### DON'TS
559+
### DON'TS
529560

530561
1. **Don't write manually instead of copy/pasting**:
531562
- You might write file paths incorrectly
@@ -547,7 +578,7 @@ Why use many token when few token do trick?
547578

548579
---
549580

550-
## 🎯 PROMPT SELECTION FLOWCHART
581+
## PROMPT SELECTION FLOWCHART
551582

552583
```
553584
What do I want to do?
@@ -560,6 +591,7 @@ What do I want to do?
560591
├─ Performance optimization (SCENARIO 8)
561592
├─ External service integration (SCENARIO 11)
562593
├─ Deployment (SCENARIO 12)
594+
├─ Update system / version sync (SCENARIO 17)
563595
├─ Emergency (SCENARIO 13)
564596
├─ Sprint planning (SCENARIO 14)
565597
├─ Model switching (SCENARIO 3)
@@ -570,7 +602,7 @@ What do I want to do?
570602

571603
---
572604

573-
## 💡 EXTRA TIPS
605+
## EXTRA TIPS
574606

575607
### Token Efficiency
576608
- First session: FULL context (3000-4000 tokens spent, saves later)

0 commit comments

Comments
 (0)