rajatsainju2025/code-explainer

Add example datasets and examples/ README for quick start

Offen

#1 geöffnet am 08.08.2025

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (0 Forks)auto 404
good first issuehelp wanted

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Create a small example dataset (data/train.json, data/eval.json, data/test.json) with ~10 items and an examples/ README showing how to train, evaluate, and serve using different presets (default distilgpt2, codet5-small). Include copy-pastable commands (cx-train, code-explainer eval, cx-serve).

Contributor Guide

Research-Richtung
Erstellen Sie Beispieldatensätze im Ordner data/ mit JSON Dateien für train, eval, test. Schreiben Sie eine examples/README.md mit Schritt für Schritt Anleitung und kopierbaren Befehlen.
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.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
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.
85