AnswerDotAI/shell_sage

Create Development Environment Setup Guide

Ouverte

#34 ouverte le 15 févr. 2025

Voir sur GitHubGuide contributeur
 (5 commentaires) (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 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

Guide contributeur

Direction de recherche
Examinez la documentation existante du projet pour comprendre le flux de travail de développement. Suivez le flux de travail nbdev pour créer un guide de configuration. Cela inclut l'installation des dépendances, la configuration des hooks de pré validation et la documentation des tâches courantes.
Stack technique
python
Domaine
documentation
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
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
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80