PolicyEngine/policyengine-core

Add type hints to all variables

Open

#3 opened on Oct 2, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (29 forks)auto 404
good first issue

Repository metrics

Stars
 (19 stars)
PR merge metrics
 (PR metrics pending)

Description

Type hints, as well as being good practice, enable IDEs like Visual Studio Code to provide relevant information about properties at the time of writing. We should annotate all non-inferable types in the codebase to aid this.

Contributor guide

Research direction
Identify variables without type hints and add type annotations following Python typing conventions.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
75