Skip to content

Commit 401b79f

Browse files
committed
Docs: Synchronize technical ethics implementation with public guides
1 parent c75a07f commit 401b79f

3 files changed

Lines changed: 12 additions & 1 deletion

File tree

.env.example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ GROQ_API_KEY=""
1010
# LLM_PROVIDER="groq"
1111
# MODEL_NAME="llama3-8b-8192" # Use gpt-4o for OpenAI, llama3-8b-8192 for Groq
1212

13+
# Ethical & Sensitivity Settings
14+
# CULTURAL_DIRECTNESS_LEVEL="high" # Options: low, medium, high
15+
# COOLING_OFF_PERIOD_HOURS=48
16+
17+
1318
# Infrastructure
1419
REDIS_URL="redis://localhost:6380"
1520
DATABASE_URL="postgresql+asyncpg://postgres:postgres@localhost:5432/commitguard"

docs/guides/managers.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,8 @@ High-stakes interventions should never be 100% autonomous.
3131
## 3. Best Practices for Professionalism
3232
* **Public vs. Private**: CommitGuard monitors public channels, but follow-up interventions for **high-risk signals** should often be moved to a 1-on-1 private DM thread once the manager is alerted.
3333
* **Celebrate the Reliability**: When someone consistently hits 100% on their Reliability Score, use the report as a basis for formal recognition. Accountability is as much about **Praise** as it is about Progress.
34+
## 4. Configuring Your Team's Voice 🎚️
35+
Managers can adjust the system's "psychological pressure" via environment variables:
36+
37+
* **`CULTURAL_DIRECTNESS_LEVEL`**: Set to `low` for high-context or sensitive teams. This forces the LLM to use more indirect, softer language even when flagging risks.
38+
* **`COOLING_OFF_PERIOD_HOURS`**: Adjust the duration of the "Tone Damping" state (Default: 48 hours).

docs/overviews/ethics.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ One of our most discussed features is the **"Confrontational"** tone. Here is ho
99

1010
* **The Empathy Buffer**: The system is hardcoded to prioritize `SUPPORTIVE` tones if anything resembling burnout or personal distress is detected.
1111
* **The Burnout Safety Valve**: If the `ExcuseDetector` identifies signs of fatigue, the system **blocks** confrontational escalation and triggers a "Burnout Alert" for the manager instead.
12-
* **Tone Drift & Cooling-off**: To prevent morale fatigue, the system implements **tone-damping**. If a user has received multiple "Firm" follow-ups, the system enters a 48-hour "Cooling-off" state where only supportive or neutral tones are permitted to avoid wearing down the individual.
12+
* **Tone Drift & Cooling-off**: To prevent morale fatigue, the system implements **mathematical tone-damping**. If a user receives **3 consecutive "Firm" or "Confrontational" follow-ups**, the logic automatically locks the agent into a `NEUTRAL` or `SUPPORTIVE` state for 48 hours (configurable via `COOLING_OFF_PERIOD_HOURS`).
13+
1314

1415
## 2. Cultural & Contextual Sensitivity
1516
"Deflection" is relative. What is seen as blunt in one culture is polite in another:

0 commit comments

Comments
 (0)