Skip to content

Commit 385373e

Browse files
committed
Update README with detailed explanation of health shields and their maintenance
1 parent 7c99635 commit 385373e

15 files changed

Lines changed: 160 additions & 62 deletions

GEMINI.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,15 @@ This document contains foundational mandates for the AI assistant (Gemini) durin
1414
- **Validation:** No logic changes are complete without corresponding unit tests. For complex system interactions, utilize `Mythril.Headless` scenario-based tests. For UI components, use `bUnit` tests.
1515
- **Documentation:** Keep documentation synchronized with code changes. Staleness is tracked locally by file modification times.
1616
- **Source Control Awareness:** All changes must be properly committed with clear, descriptive messages.
17-
- **Feedback Integrity:** User feedback must be technically resolved, not just dismissed. Every cleared item in `docs/feedback/` or `docs/errors/` must have a corresponding technical resolution file in `docs/resolution/`.
18-
- **Credential Protection:** Never log, print, or commit secrets, API keys, or sensitive URLs.
17+
- **Feedback Integrity**: User feedback must be technically resolved, not just dismissed. Every cleared item in `docs/feedback/` or `docs/errors/` must have a corresponding technical resolution file in `docs/resolution/`.
18+
- **AI Guidance System**: When facing architectural or strategic ambiguity, agents must:
19+
1. Consult `docs/guidence_knowledge_base.md` for existing decisions.
20+
2. If no guidance exists, create a new request in `docs/guidence/` using the template in `docs/guidence.md`.
21+
3. **Granularity**: Each high-level question or distinct topic must be its own file to facilitate focused discussion and tracking. Group questions into a single file only if they are tightly coupled.
22+
4. Naming convention: `YYYY-MM-DD_topic.md`.
23+
4. Wait for human developer response before implementing high-level structural changes.
24+
- **Credential Protection**: Never log, print, or commit secrets, API keys, or sensitive URLs.
25+
1926
- **Agentic DevOps:** The AI is responsible for the entire DevOps lifecycle within the project scope.
2027
- **Source Control Submission:** Always commit changes to the git repository **and push to the remote origin** upon completing a task. Push directly to the `main` branch.
2128

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,16 @@ We maintain project health through a custom automated suite (`scripts/check_heal
5555
- **Documentation Integrity**: Automated staleness tracking via local file modification times.
5656
- **Feedback Integrity**: Monitoring of pending user feedback and runtime errors in `docs/feedback/`.
5757

58+
### 🛡️ Health Shield Guide
59+
All badges are automatically updated by `scripts/check_health.py` on every commit:
60+
- **Tests**: Status of the entire MSTest suite. Fails if any unit test is broken.
61+
- **Coverage**: Total line coverage percentage. Must remain above 70% overall.
62+
- **Monoliths**: A count of source files exceeding 250 lines. Aiming for 0 for maximum maintainability.
63+
- **Docs**: Staleness indicator. Flags documentation if more than 10 source changes occur without a doc update.
64+
- **UI Integrity**: Validates bUnit test presence, `@key` usage in loops, and stable `data-testid` anchors.
65+
- **Reachability**: Result of the Game Graph Simulation. Verifies all content is mathematically attainable.
66+
- **Optimal Completion**: The minimum real-world time required to finish the current endgame content.
67+
5868
## 🚀 Getting Started
5969
1. **Build**: `dotnet build`
6070
2. **Test**: `dotnet test`
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guidance Request: Architectural Philosophy (Complexity vs. Performance)
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
Many proposed suggestions (Dungeons, Base Building) add significant state complexity and potential performance overhead.
8+
9+
## Questions
10+
1. Should we prioritize horizontal expansion (more locations/cadences with simple logic) or vertical depth (more complex, interconnected systems per character)?
11+
12+
## Human Guidance
13+
These are equally important. Do both in tandem.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guidance Request: Automation Philosophy
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
"Logistics" and "AutoQuest" systems allow for increasing levels of idleness.
8+
9+
## Questions
10+
1. How "idle" should the game be? Should "Logistics" eventually reach a point where the entire party can run autonomously, or should there always be a manual bottleneck (e.g. manual restart required for certain tiers)?
11+
12+
## Human Guidance
13+
[BLANK]
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guidance Request: Character Narrative Identity
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
Currently, the three party members are identical except for their names.
8+
9+
## Questions
10+
1. Do you want characters to remain "blank slates" for the user to customize, or should they have fixed narrative roles/starting passives that influence their optimal builds?
11+
12+
## Human Guidance
13+
[BLANK]
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Guidance Request: Equipment System Implementation
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
Proposed equipment slots for Weapons and Armor.
8+
9+
## Questions
10+
1. Should equipment be consumed (like magic in refinements) or permanent items?
11+
2. How does this balance with the existing "Junctioning is everything" design philosophy?
12+
13+
## Human Guidance
14+
[BLANK]
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guidance Request: Progression Pacing (The Wall)
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
Balancing the transition from early to mid-game.
8+
9+
## Questions
10+
1. At what point in real-world time (e.g. 2 hours, 10 hours) should the player hit the first significant "grind" where they must optimize junctions to proceed?
11+
12+
## Human Guidance
13+
[BLANK]
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guidance Request: Resource Scarcity
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
Mythril Spark is currently a rare one-time reward.
8+
9+
## Questions
10+
1. Should rare resources remain strictly one-time rewards to gate progression, or should there be an extremely difficult recurring path to obtain them?
11+
12+
## Human Guidance
13+
[BLANK]
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guidance Request: Stat Caps and Scaling
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
With the new simulation tool, we see stats reaching 100-200.
8+
9+
## Questions
10+
1. Is there a mathematical "ceiling" we should aim for, or should stat requirements and junction bonuses scale infinitely?
11+
12+
## Human Guidance
13+
[BLANK]
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guidance Request: Visual Aesthetic Direction
2+
3+
**Date:** 2026-03-04
4+
**Agent:** Gemini CLI
5+
6+
## Context
7+
The UI is currently a minimalist dashboard.
8+
9+
## Questions
10+
1. Should we stick to the clean minimalist look, or should we introduce more illustrative elements such as character portraits, map icons, or item sprites?
11+
12+
## Human Guidance
13+
[BLANK]

0 commit comments

Comments
 (0)