Audit Add-Ons/ Quality control checklist

Ouverte
#238 0 commentaires 0 réactions 1 personne assignée Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@duckduckgrayduck y travaille déjà.

Depuis le 25/7/2024.

Évaluation

Cette issue n'a pas encore été évaluée.

Description

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?

Langage dominant
Python
Étoiles
55
Forks
10
Merge moyen
1 j 13 h
PR mergées (30 j)
22

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de MuckRock/documentcloud

Toutes les issues de MuckRock/documentcloud

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.