linuxboot / linuxboot/contest

[v2] make job descriptor JSON5 compatible

Open
#138 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue v2_overhaul
Dominant language
Go
Stars
20
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Current state: the serialization/deserialization of JSON is done with the golang "encoding/json" package which only understands the standard ECMA flavor.
It has proven useful to have comments in the input descriptors, so we should use a format that supports that.

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

No file or test is named in the issue. Start by locating the job descriptor serialization and deserialization that use Go's encoding/json package, then identify a JSON5-compatible format or parser. Done means descriptors containing comments can be read while serialization and deserialization continue to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
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.