rajatsainju2025/code-explainer

Add example datasets and examples/ README for quick start

Open

#1 opened on Aug 8, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (0 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

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 direction
Create example datasets in data/ folder with JSON files for train, eval, test. Write examples/README.md with step by step instructions and copy pastable commands.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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.
85