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 合併指標
 (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