AnswerDotAI/shell_sage

Create Development Environment Setup Guide

Aberta

#34 aberto em 15 de fev. de 2025

Ver no GitHubGuia do colaborador
 (5 comentários) (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 detailed development setup documentation including:

  • Required Python versions and dependencies
  • nbdev workflow explanation
  • Common development tasks
  • Troubleshooting guide

Example additions:

## Development Setup
1. Install dependencies:
```bash
pip install -e '.[dev]'
nbdev_install_quarto
  1. Setup pre-commit hooks:
nbdev_install_hooks


Estimated time: 2-4 hours

Guia do colaborador

Direção de pesquisa
Revise a documentação existente do projeto para entender o fluxo de trabalho de desenvolvimento. Siga o fluxo de trabalho nbdev para criar um guia de configuração. Isso inclui instalar dependências, configurar ganchos de pré confirmação e documentar tarefas comuns.
Pilha de tecnologia
python
Domain
documentation
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
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
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80