Add CONTRIBUTING.md and fix persona list in getting started guide

- Create contribution guide with bug reporting, PR guidelines, and code of conduct focused on therapeutic safety - Fix incomplete persona list to show all 5 styles: warm & supportive, warm 4o-style, direct & challenging, coach, grounded & real Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 23:06:07 -08:00
parent afccf52570
commit 10531322c7
5 changed files with 49 additions and 204 deletions
@@ -0,0 +1,48 @@
 # Contributing to AI Therapy Kit
 Thank you for your interest in contributing! This project helps people access emotional support through AI, so we take contributions seriously.
 ## Reporting Bugs
 1. Check existing [issues](https://github.com/ataglianetti/ai-therapy-kit/issues) to avoid duplicates
 2. Create a new issue with:
   - Clear description of the problem
   - Steps to reproduce
   - Expected vs actual behavior
   - Your setup (OS, Claude Code version)
 ## Suggesting Features
 Open an issue with the "feature request" label. Include:
 - What problem does this solve?
 - Who would benefit?
 - Any implementation ideas?
 ## Pull Requests
 1. Fork the repository
 2. Create a feature branch (`git checkout -b feature/your-feature`)
 3. Make your changes
 4. Test thoroughly
 5. Submit a PR with a clear description
 ### What We're Looking For
 - Additional therapeutic modalities (must have clinical grounding)
 - Improved crisis detection and safety protocols
 - Local LLM integration guides
 - Translations
 - Documentation improvements
 ## Code of Conduct
 This project deals with mental health and emotional wellbeing. Please:
 - **Prioritize safety** — Changes to crisis detection or safety protocols require extra scrutiny
 - **Respect privacy** — Never suggest changes that would transmit user data
 - **Be evidence-based** — Therapeutic approaches should have clinical support
 - **Be kind** — Users of this project may be vulnerable; keep that in mind
 ## Questions?
 Open an issue or reach out to the maintainer.
@@ -1,114 +0,0 @@
 # Asset Capture Instructions
 This folder needs three visual assets for the README. Follow these instructions to create them.
 ---
 ## Required Assets
 | File | Description | Target Size |
 |------|-------------|-------------|
 | `session-screenshot.png` | Terminal showing therapy conversation | ~800x500px |
 | `session-notes.png` | Markdown file in a viewer | ~600x400px |
 | `demo.gif` | Animated demo of starting a session | Under 5MB |
 ---
 ## 1. Session Screenshot (`session-screenshot.png`)
 ### Setup
 1. Open terminal with a clean theme (dark background recommended)
 2. Navigate to a test Sage folder
 3. Run `claude`
 ### Content to Use
 See `sample-session-content.md` for the exact conversation.
 ### Capture
 - **Mac**: Cmd+Shift+4, then press Space to capture just the window
 - **Windows**: Alt+PrintScreen or Win+Shift+S
 - Crop to remove any personal info from title bar if needed
 ### Tips
 - Font size 14-16pt for readability
 - Ensure text is crisp and readable
 - No personal paths visible in prompt
 ---
 ## 2. Session Notes Screenshot (`session-notes.png`)
 ### Setup
 Open `sample-session-notes.md` in one of these viewers:
 - **VS Code** with markdown preview (Cmd+Shift+V)
 - **Marked 2** (Mac)
 - **Typora**
 - **GitHub** (commit the file, screenshot it there)
 ### Content
 Use `sample-session-notes.md` exactly as written.
 ### Capture
 - Show the rendered markdown, not raw text
 - Clean, minimal theme preferred
 - Crop to just the content area
 ---
 ## 3. Demo GIF (`demo.gif`)
 ### Tools
 - **Mac**: QuickTime (record) + Gifski (convert)
 - **Windows**: ScreenToGif, ShareX
 - **Any**: Kap, LICEcap
 ### What to Record
 1. Show desktop with launcher script visible
 2. Double-click `start-session.command`
 3. Terminal opens
 4. Sage's greeting appears
 5. Type: "I've been feeling overwhelmed at work lately"
 6. Response streams in
 7. End after first response completes
 ### Settings
 - Resolution: 800x500 or similar
 - Frame rate: 10-15 fps (keeps file small)
 - Duration: 15-30 seconds
 - Loop: yes
 ### Optimization
 Target under 5MB. If too large:
 ```bash
 # Using gifski (install via: brew install gifski)
 gifski --fps 10 --width 800 -o demo.gif recording.mov
 # Using ffmpeg
 ffmpeg -i recording.mov -vf "fps=10,scale=800:-1" -loop 0 demo.gif
 ```
 ---
 ## After Capturing
 1. Add the three files to this folder:
   - `session-screenshot.png`
   - `session-notes.png`
   - `demo.gif`
 2. Delete these instruction files:
   - `CAPTURE-INSTRUCTIONS.md`
   - `sample-session-content.md`
   - `sample-session-notes.md`
 3. Verify in README that images load correctly
 ---
 ## Quick Checklist
 - [ ] Screenshots are clean (no personal info, no clutter)
 - [ ] Text is readable at normal zoom
 - [ ] GIF is under 5MB
 - [ ] All three assets added to `assets/`
 - [ ] README images render on GitHub
@@ -1,71 +0,0 @@
 # Sample Session Content for Screenshots
 Use this content when capturing screenshots for the README.
 ---
 ## Terminal Session View
 ```
 You: I've been feeling overwhelmed at work lately. Too many deadlines,
     not enough time, and I keep saying yes to things I shouldn't.
 Sage: That sounds exhausting - carrying more than you have capacity for,
      and feeling like you can't say no. What happens when you imagine
      setting a boundary with someone at work?
 You: Honestly? Anxiety. Like they'll think I'm not a team player or
     that I can't handle my job.
 Sage: So there's a fear underneath - that saying no means something
      negative about you. "Not a team player" or "can't handle it."
      I'm curious: where did you first learn that your worth was tied
      to how much you could take on?
 ```
 ---
 ## Screenshot Instructions
 ### 1. Terminal Setup
 - Use a clean terminal theme (recommend: dark background, light text)
 - Font size: 14-16pt for readability
 - Window size: ~800x500px
 ### 2. Capture Process
 1. Open terminal in a clean Sage folder
 2. Run `claude` to start a session
 3. Type the user messages shown above
 4. Wait for AI responses
 5. Take screenshot when conversation looks natural
 ### 3. Tools
 - **Mac**: Cmd+Shift+4 then Space to capture window
 - **Windows**: Win+Shift+S for snipping tool
 - **Any**: Use CleanShot X, ShareX, or similar
 ---
 ## GIF Recording Instructions
 ### Recommended Tools
 - **Mac**: Gifski (App Store) + QuickTime
 - **Windows**: ScreenToGif, ShareX
 - **Cross-platform**: ffmpeg, Kap
 ### Recording Steps
 1. Position terminal window prominently
 2. Start recording (800x500px area)
 3. Double-click `start-session.command`
 4. Wait for terminal to open
 5. Wait for Sage's greeting
 6. Type: "I've been feeling overwhelmed at work lately"
 7. Wait for response to stream in
 8. Stop recording after response completes
 ### GIF Optimization
 - Target: under 5MB
 - Frame rate: 10-15fps is fine
 - Colors: reduce to 256 if needed
 - Duration: 15-30 seconds
@@ -1,18 +0,0 @@
 # Session: January 15, 2025
 ## Key Themes
 - Work overwhelm and difficulty setting boundaries
 - Fear of being seen as "not a team player"
 - Connection between self-worth and productivity
 ## Emotional State
 - Exhausted, anxious when discussing boundaries
 - Some relief in naming the pattern
 ## Patterns Noted
 - People-pleasing at cost of own wellbeing
 - Worth tied to capacity/output (likely early origin)
 ## Threads to Revisit
 - Origin of "worth = what I can handle" belief
 - Small boundary experiment for next week
@@ -58,7 +58,7 @@ claude
 Claude will guide you through setup by asking a few questions:
 1. **Therapist name** — What to call your AI therapist (e.g., Sage, Willow, Quinn)
-2. **Communication style** — Warm, direct, coach-like, or down-to-earth
+2. **Communication style** — Warm & supportive, warm 4o-style, direct & challenging, coach, or grounded & real
 3. **Therapeutic approaches** — Which methods to use (CBT, ACT, DBT, etc.)
 4. **Storage location** — Where to save your session files
 5. **Import history** (optional) — Bring in notes from ChatGPT or other tools