Audit Add-Ons/ Quality control checklist

オープン
  • 何か問題がありますか？
#238 コメント 0 件 リアクション 0 件 担当者 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時間
マージ済み PR（30日）
22

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

MuckRock/documentcloud のほかの issue

MuckRock/documentcloud の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。