Audit Add-Ons/ Quality control checklist

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

维护者通常 1 天内回复

@duckduckgrayduck 已经在做这个了。

开始于 2024年7月25日。

评估

这个 Issue 还没有评估数据。

描述

documentation question

Came to mind today that we have a large collection of Add-Ons now and occasionally some small issues arise here and there. It would be nice to do an audit. Here are some of the things that should be done for each Add-On for quality control.

  • Does the Add-On have a category (AI, File, Extraction)?

  • Is the Add-On listed here? https://www.documentcloud.org/help/add-ons

  • Is python-documentcloud set to the most recent stable version of python-documentcloud (at the time of this issue creation 4.1.3)?

  • Does the Add-On use self.get_documents() to iterate through documents for readability?

  • If the Add-On offers the choice of running on a selection or query of documents, does it use the selected documents as default?

  • Does the Add-On have a reasonable timeout or use SoftTimeOut if eligible?

  • pylint/black?

  • If the Add-On saves data back to DocumentCloud (save(), put(), delete(), etc), do we wrap API calls in try/except and handle the errors providing useful error messages to the user?

  • If the Add-On makes network requests or outside API calls do we use exponential back-off with tenacity where appropriate?

主要语言
Python
星标
55
派生
10
平均合并
1 天 13 小时
30 天内合并 PR
22

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

MuckRock/documentcloud 的其他 Issue

查看 MuckRock/documentcloud 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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