FluxML/Zygote.jl

Add devdocs for important internal functions

Open

#1,274 opened on Jul 31, 2022

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Julia (220 forks)batch import
good first issuehelp wantedup for grabs

Repository metrics

Stars
 (1,568 stars)
PR merge metrics
 (Avg merge 2d 16h) (39 merged PRs in 30d)

Description

These may be as simple as a couple lines of comments, but as noted in https://github.com/FluxML/Zygote.jl/issues/1243#issuecomment-1200400917 they would be good to have:

Contributor guide

Research direction
Review the internal functions listed and add inline documentation explaining their purpose and usage.
Tech stack
julia
Domain
backend
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.
Under 1 hour
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
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90