urbit/vere

Annotate struct fields in `tree.c`

Open

#172 opened on Jan 26, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C (53 forks)auto 404
good first issue

Repository metrics

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

Description

The array definitions in tree.c will be easier to read and understand if we annotate their constituent struct definitions with the relevant struct's field names rather than relying on the implicit field ordering defined by the declaration of the struct in jets.h.

Contributor guide

Research direction
Examine the struct definitions in jets.h and add field name comments to the array initializations in tree.c.
Tech stack
c
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
C language basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90