AnswerDotAI/shell_sage

Create Development Environment Setup Guide

Open

#34 opened on Feb 15, 2025

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Jupyter Notebook (44 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (406 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the existing project documentation to understand the development workflow. Follow the nbdev workflow to create a setup guide. This includes installing dependencies, setting up pre commit hooks, and documenting common tasks.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80