INCATools / INCATools/boomer

JSON filenames that are hashed have no mention in the `output.md` file

Open
#323 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
37
Forks
2
PR merge metrics
No merged PRs in 30d

Description

If I need to see the JSON or PNG of the report associating with an entry in `output.md`, I cannot directly find it without some `grep` on the command line.

Discussed with Jim about having that as an entry in the `output.md` file itself to track it to the corresponding JSON/PNG file.

Contributor guide

No contributing guide indexed for this repository

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 code that generates output.md and the associated JSON and PNG report files. Trace how report entries are written and determine how the corresponding filenames can be included. Done means each relevant output.md entry directly identifies its JSON and PNG files.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
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.