PolicyEngine / PolicyEngine/policyengine-core
Add type hints to all variables
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 22
- Forks
- 30
- Avg merge
- 14h 33m
- Merged PRs (30d)
- 7
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
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 by inventorying the Python codebase and identifying variables whose types cannot be inferred. Define the annotation scope before changing files, then verify that all non-inferable variables are annotated and that the codebase remains usable with the intended IDE support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100