MattIPv4 / MattIPv4/PyDMXControl

[Python] Implement docstrings and testing

未关闭
#15 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

good first issue hacktoberfest help wanted 🆕 Enhancement
主要语言
Python
星标
143
派生
23
PR 合并指标
30 天内没有已合并 PR

描述

Currently the library has a lot of code dumped throughout that has no documentation associated to explain what it does. Additionally, there is no real testing in place to ensure older methods are not broken by never changes etc.

Therefor, implementing correct docstrings throughout the code and implementing proper testing would be a good way to bring up the quality of the library.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

该 issue 未列出任何文件、测试或入口点。首先调研 Python 库,以确定 docstring 和回归测试的范围;完成要求包括为代码编写文档,并提供能够保护现有方法的有意义测试。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation, testing
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
20/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。