AnswerDotAI/shell_sage

Create Development Environment Setup Guide

Aperta

#34 aperta il 15 feb 2025

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)Jupyter Notebook (44 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

Star
 (406 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina la documentazione esistente del progetto per comprendere il flusso di lavoro di sviluppo. Segui il flusso di lavoro nbdev per creare una guida di configurazione. Include l'installazione delle dipendenze, la configurazione degli hook pre commit e la documentazione delle attività comuni.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80