aicuriousminds/retrieval-augmented-generation

Set up Python Linting & TypeChecking

开放

#4 创建于 2024年5月25日

在 GitHub 查看
 (0 条评论) (0 个反应) (1 位负责人)Python (0 个派生)auto 404
good first issue

仓库指标

星标
 (1 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Currently we don't have any linting or typechecking. My suggestions are:

Assuming this, we should:

  • add linting
  • add typechecking
  • add git pre-commit hook to ensure that these are run on commit

贡献者指南

研究方向
设置Ruff用于代码检查，MyPy用于类型检查，然后配置pre commit钩子以自动运行它们。
技术栈
python
领域
developer experience
议题类型
维护
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80