tracel-ai/burn

Getting started with repo template using cargo-generate

Open

#282 opened on Apr 9, 2023

View on GitHubContributor guide
 (8 comments) (5 reactions) (0 assignees)Rust (964 forks)auto 404
accessibilityexamplegood first issuehelp wanted

Repository metrics

Stars
 (15,550 stars)
PR merge metrics
 (PR metrics pending)

Description

It's often helpful if there is a repo template with all right set up for new comers. We can use a tool such as cargo-generate (see this example project) to generate a pre-defined project.

Contributor guide

Research direction
Investigate existing cargo generate templates (e.g., rust tui template) and propose a template structure for the Burn library that includes essential boilerplate (Cargo.toml, basic modules, examples).
Tech stack
rust
Domain
developer experience
Issue type
Feature
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.
1-3 hours
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
RustCargocargo generate
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75