AnswerDotAI/shell_sage

Document Logging System

Offen

#35 geöffnet am 15.02.2025

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Jupyter Notebook (44 Forks)auto 404
documentationgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie das Datenbankschema und die Konfigurationsdateien für das Logging im Codebase und erstellen Sie dann die Dokumentation basierend auf den aufgeführten Beispielen und Anforderungen.
Tech Stack
Keine
Domain
backend
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.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85