opensearch-project/demos

[FEATURE][DocBot] Add mypy type checking

Open

#92 opened on Nov 6, 2023

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees) (18 forks)auto 404
OSCIenhancementgood first issue

Repository metrics

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

Description

Is your feature request related to a problem?

At the moment we have types in our project but we dont have a pattern for regularly checking and validating the types.

What solution would you like?

As a pre-commit hook we should enable mypy which will help us with doing typechecking.

Additionally we need to go through and validate the types are correct for the things that we have typed.

Contributor guide

Research direction
Look at the existing pre commit configuration in the repository, add a mypy hook to .pre commit config.yaml, and configure mypy settings (e.g., mypy.ini). Ensure all existing code passes type checks or add type hints where missing.
Tech stack
python
Domain
tooling
Issue type
Feature
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.
1-3 hours
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
PythonGitpre commit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75