警告关于无人看管的分支和FIXME或TODO注释
项目描述
check-oldies 是一组程序，用于警告代码中的旧事物
check-fixmes 警告关于旧的FIXME或TODO注释和孤儿FUTURE标签。
如果我们不定期检查，我们就会忘记我们几个月前写的那个 FIXME 注释。 check-fixmes 会提醒我们。然后，我们选择采取行动：修复它、删除它（因为我们决定它不值得修复，或者因为它不再相关），或者推迟它。
FUTURE 标签：我们有时会计划一个涉及多个文件的广泛修改。我们不会到处都写上 FIXME 注释，而是在同一行上设置一个 FIXME 注释和一个 FUTURE-xxx 标签。然后，无论我们需要在哪里进行修改，我们只需提及这个 FUTURE-xxx 标签，而不需要任何 FIXME。如果我们删除了 FIXME 但在某个地方保留了 FUTURE-xxx 标签，那么这是一个错误，这个工具会提醒我们。
check-branches 会提醒我们关于旧分支，这很令人惊讶。
forget-me-not 在一组 Git 仓库上运行上述两个程序，并向即将过时的注释或分支的作者发送警告电子邮件。
换句话说： check-fixmes 和 check-branches 可以作为每个项目的测试套件的一部分运行（通过 Jenkins 等持续集成系统）。当它们检测到旧事物时，它们会中断构建。另一方面，forget-me-not 可以每周运行一次，以提醒作者，如果他们不处理他们的旧注释或分支，一些构建 将会 立即中断。
示例输出
$ check-fixmes NOK: Some annotations are too old, or there are orphan FUTURE tags. jdoe - 181 days - frobulator/api.py:12: # FIXME (jdoe): we should catch errors jdoe - 100 days - frobulator/api.py:25: # TODO: this is slow, use the batch API instead jsmith - 12 days - docs/index.rst:1: # FIXME: write documentation before open sourcing
$ check-branches NOK: Some branches are too old. john.smith@example.com - 92 days - jsmith/fix_frobs (https://github.com/Polyconseil/check-oldies/tree/jsmith/fix_frobs), linked to open PR/MR #1 (https://github.com/Polyconseil/check-oldies/pull/1)
适用性
check-oldies 是用 Python 编写的，但与语言无关。它适用于 Git 仓库，但可以扩展到其他版本控制系统。它可以与 GitHub 集成，但也可以不使用它，并且可以扩展到与其他代码托管平台一起工作。
需求和安装
您必须安装 Python 3.7 或更高版本，以及一个相对较新的 Git 版本。已知的 Git 2.1.4（随 Debian Jessie 一起提供）可以正常工作。更早的版本应该可以正常工作，并受到支持。
使用 pip 安装，最好是在虚拟环境中
$ python3 -m venv /path/to/your/virtualenv
$ source /path/to/your/virtualenv/bin/activate
$ pip install "check-oldies[toml]"功能、配置和更多
完整的文档 https://check-oldies.readthedocs.io/ 提供了有关功能和配置的更多详细信息，以及 FUTURE 标签的使用示例、如何贡献等。
check_oldies-0.8.10-py2.py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 0555f48fcf2655d971776a8ec34b982eb7240095a0bbb938ff9cf882c615fbf4 |
|
| MD5 | e6515ca7db98c07ea714e49b0b704884 |
|
| BLAKE2b-256 | 0ce690a33cce3f0687981a546a5ac89db545a47bbb8490ceb7641c100bfa3977 |
