opensearch-project/demos

[FEATURE][DocBot] Add mypy type checking

开放

#92 创建于 2023年11月6日

在 GitHub 查看贡献者指南
 (1 条评论) (0 个反应) (0 位负责人) (18 个派生)auto 404
OSCIenhancementgood first issue

仓库指标

星标
 (4 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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.

贡献者指南

研究方向
查看仓库中现有的 pre commit 配置，将 mypy 钩子添加到 .pre commit config.yaml 中，并配置 mypy 设置（例如 mypy.ini）。确保所有现有代码通过类型检查，或在缺失处添加类型提示。
技术栈
python
领域
tooling
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonGitpre commit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75