MatthewPeterKelly/fractal-renderer

Standardize JSON exporting

Open

#131 opened on Mar 7, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (0 forks)github user discovery
buggood first issue

Repository metrics

Stars
 (6 stars)
PR merge metrics
 (Avg merge 1d 16h) (6 merged PRs in 30d)

Description

(1) When rendering an image, the parameters are written back to a file in the output directory alongside the rendered image and diagnostics. But, they are generated from the fractal-specific parameters (eg. BarnsleyFernParams), rather than the top-level FractalParams. This means, that if you try to directly pass them to the render command, without wrapping them in the type annotation, that the render command will fail.

(2) The explore mode only exports the ImageSpecification data to the JSON, but it should explore the entire FractalParams, with the updated image specification details.

Perhaps both of these can be fixed with a similar technique.

Contributor guide

Research direction
Examine the serialization of FractalParams and ensure both the export of parameters and explore mode use the top level FractalParams struct with proper JSON serialization. Modify the renderer to write the entire FractalParams instead of the nested fractal specific params, and update explore mode to export the full FractalParams including ImageSpecification.
Tech stack
rust
Domain
backendcli
Issue type
Bug
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
RustJSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70