resgroup / resgroup/wind-up

raise error if yaml contains keys not used by `WindUpConfig`

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

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
29
Forks
11
Avg merge
1d 9h
Merged PRs (30d)
11

Description

I believe if you include keys in a config yaml which are not attributes of WindUpConfig no error is raised. This is not ideal because if you misspell a key and it has a default value then your intended value won't take effect and you will get no indication of this.

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 YAML loading and WindUpConfig definition. Trace how configuration keys are mapped, then add coverage for an unused or misspelled key and verify that loading reports an error instead of silently ignoring it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.