StackGuardian / StackGuardian/tirith
Improve code structure and metadata for providers
Open
Nobody has claimed this yet.
need-discussion
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
The current implementation of the providers has several areas that need improvement to enhance clarity, maintainability, and robustness.
- There is no clear documentation or structure indicating which arguments are required for each operation type (input_type). This can lead to confusion and errors in usage.
- There is no straightforward way to list all supported input_type values programmatically. This could be solved by defining a constant or enumeration for operation types.
- Functions aren't modular/reusable.
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
Locate the provider implementations and review how each operation's input_type and required arguments are currently represented. Define what metadata must be exposed, how supported input_type values should be listed, and which functions need modularization; done means the structure is clearer, operations are discoverable programmatically, and reusable functions cover the existing provider behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devops, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100