AnswerDotAI/shell_sage

Document Logging System

Ouverte

#35 ouverte le 15 févr. 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Jupyter Notebook (44 forks)auto 404
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (406 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Add documentation for the logging system including:

  • Database schema
  • Query examples
  • Log maintenance
  • Configuration options

Example additions:

## Logging
Logs are stored in SQLite at ~/.shell_sage/log_db/logs.db

Schema:
- timestamp: DateTime
- query: Text
- response: Text
- model: Text

Estimated time: 1-2 hours

Guide contributeur

Direction de recherche
Examinez le schéma de la base de données de journalisation et les fichiers de configuration dans le code source, puis rédigez la documentation en vous basant sur les exemples et les exigences listés.
Stack technique
Aucun
Domaine
backend
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.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85