Audit Add-Ons/ Quality control checklist

Abierto
#238 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@duckduckgrayduck ya está trabajando en esto.

Desde el 25/7/2024.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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?

Lenguaje dominante
Python
Estrellas
55
Forks
10
Merge medio
1 d 13 h
PR fusionados (30 d)
22

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de MuckRock/documentcloud

Todos los issues de MuckRock/documentcloud

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.