StackGuardian / StackGuardian/tirith
feat(core): rename `meta.required_provider` to `meta.provider`, keeping backward compatibility
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
The policy metadata key meta.required_provider should be simply meta.provider. The engine reads
the key in src/tirith/core/core.py (start_policy_evaluation_from_dict, around line 370) and
echoes it into the result metadata a few lines below.
Tasks
- Accept both keys:
providerpreferred,required_providerstill working so every existing
policy keeps functioning unchanged (optionally a deprecation note in--verboseoutput). - Keep the result metadata consistent whichever spelling the policy used.
- Tests covering both spellings, and precedence when both are present.
- Update the README, docs and example policies to the new key.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in src/tirith/core/core.py at start_policy_evaluation_from_dict around line 370, then inspect the nearby result-metadata handling and existing tests. Cover provider, required_provider, and precedence when both are present, keeping result metadata consistent. Update the README, docs, and example policies to use the new key.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, documentation, testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100