AnswerDotAI/shell_sage

Create Development Environment Setup Guide

Offen

#34 geöffnet am 15.02.2025

Auf GitHub ansehenContributor Guide
 (5 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 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

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Projektdokumentation, um den Entwicklungsablauf zu verstehen. Folgen Sie dem nbdev Workflow, um einen Setup Leitfaden zu erstellen. Dazu gehören das Installieren von Abhängigkeiten, das Einrichten von Pre Commit Hooks und das Dokumentieren allgemeiner Aufgaben.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80