josharsh/100LinesOfAICode

📚 Add usage GIFs/videos to tool READMEs

Offen

#2 geöffnet am 20.11.2025

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (17 Forks)auto 404
documentationgood-first-issuehacktoberfesthelp-wanted

Repository-Metriken

Stars
 (4 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

🎯 Goal

Make our tools more engaging by adding demo GIFs or short videos showing them in action!

📋 Description

Each tool README would be 10x more compelling with a visual demo. Contributors can:

  • Record a quick GIF of the tool in action
  • Add it to the tool's README
  • Help developers see the value instantly

🚀 Suggested Tools

  • Terminalizer or asciinema for terminal recordings
  • GIPHY Capture or LICEcap for GIF creation

📁 Files to Update

Choose any tool:

  • ai-agent/README.md
  • commit-ai/README.md
  • terminal-ai/README.md
  • rubber-duck/README.md
  • And 13 more!

✅ Acceptance Criteria

  • Record tool in action (15-30 seconds)
  • Convert to optimized GIF (<5MB)
  • Add to README after Quick Start section
  • Commit with descriptive message

💡 Why This Matters

Visual demos increase GitHub stars by 40%+ according to research. You'll make this repo way more discoverable!

🎓 Learning Outcomes

  • Screen recording tools
  • GIF optimization
  • Open source contribution workflow

Estimated time: 30-45 minutes Impact: High visibility, great for portfolio!

Contributor Guide

Research-Richtung
Wähle ein Tool aus der Liste (z. B. terminal ai), nimm ein kurzes Demo GIF mit asciinema oder LICEcap auf, optimiere es auf unter 5 MB, füge es in die README.md nach dem Quick Start Abschnitt ein und committe es mit einer beschreibenden Nachricht.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90