Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Audit Add-Ons/ Quality control checklist #238

Open
duckduckgrayduck opened this issue Jul 25, 2024 · 0 comments
Open

Audit Add-Ons/ Quality control checklist #238

duckduckgrayduck opened this issue Jul 25, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@duckduckgrayduck
Copy link
Contributor

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?

@duckduckgrayduck duckduckgrayduck added the planning Review at project planning meeting label Jul 25, 2024
@duckduckgrayduck duckduckgrayduck self-assigned this Jul 25, 2024
@duckduckgrayduck duckduckgrayduck added documentation Improvements or additions to documentation and removed planning Review at project planning meeting labels Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant