AnswerDotAI/shell_sage

Document Logging System

Aberta

#35 aberto em 15 de fev. de 2025

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Jupyter Notebook (44 forks)auto 404
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (406 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Revise o esquema do banco de dados de log e os arquivos de configuração no código fonte, depois escreva a documentação com base nos exemplos e requisitos listados.
Pilha de tecnologia
None
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85