9elements / 9elements/firmware-action

Add support for YAML configuration as alternative to JSON

Open
#446 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature go good_first_issue low_priority quality_of_life
Dominant language
Go
Stars
22
Forks
1
Avg merge
10h 8m
Merged PRs (30d)
9

Description

JSON is nice and all, but YAML is preferred by many people. It should be relatively easy to add support.

TODO:

  • Add support for parsing YAML configuration files
  • Check the configuration file extension and select appropriate parser.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing JSON configuration parsing and the configuration-file entry point. Add YAML parsing and extension-based parser selection as described in the TODO, then verify that both JSON and YAML configuration files are accepted.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, yaml
Domain
build-system, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.