josharsh/100LinesOfAICode

📚 Add usage GIFs/videos to tool READMEs

Ouverte

#2 ouverte le 20 nov. 2025

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Python (17 forks)auto 404
documentationgood-first-issuehacktoberfesthelp-wanted

Métriques du dépÎt

Stars
 (4 étoiles)
MĂ©triques de merge PR
 (Métriques PR en attente)

Description

🎯 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!

Guide contributeur

Direction de recherche
Sélectionnez un outil dans la liste (par exemple terminal ai), enregistrez un court GIF de démonstration avec asciinema ou LICEcap, optimisez le à moins de 5 Mo, ajoutez le au README.md aprÚs la section Quick Start et faites un commit avec un message descriptif.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un trÚs petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraßche, active, ancienne, bloquée ou en attente d'un mainteneur.
RĂ©cente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critÚres d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90