StackGuardian/tirith

馃殌 Add Type Annotations

Open

#180 opened on Sep 21, 2024

View on GitHubContributor guide
聽(5 comments)聽(0 reactions)聽(1 assignee)Python聽(41 forks)auto 404
enhancementgood first issuehacktoberfest

Repository metrics

Stars
聽(168 stars)
PR merge metrics
聽(PR metrics pending)

Description

Issue: Several functions lack type annotations. Adding type hints can improve code readability and help with static type checking.

Solution: Go through the handler.py of all providers ( infracost, json, kubernetes, sg_workflow, terraform_plan ) and add type hints to functions .

Example:

def _get_exp_attribute(split_expressions: List[str], input_data: dict) -> List[Any]:

Contributor guide

Research direction
Examine each handler.py file in the providers directory and add type hints to all function definitions, ensuring arguments and return types are properly annotated.
Tech stack
python
Domain
backenddevtools
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70