llnl / llnl/INGRID

Add schema for INGRID user config files

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

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Python
Stars
11
Forks
9
PR merge metrics
No merged PRs in 30d

Description

This package is quite useful for the validation of user config files, and I've found it quite handy in other projects.

We should add a validation step that leverages this tool rather than rely on the brute-force dictionary checks we have.

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 existing brute-force dictionary checks and the code that loads user configuration files. Review the schema package linked in the issue, then determine how its validation should replace those checks; done means config validation uses the schema approach rather than the current dictionary checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.