Open Source Check List

[zwergius]

• Has PII been removed?
  • Use Clouseau for scanning source code.
  • If there are images, visually inspect each image to ensure there is no CFPB-specific information.
• Have security vulnerabilities been remediated?
• Are we including any other open source products? If so, is there any conflict with our public domain release?
• Is our TERMS.md included?
• Is a CHANGELOG.md present and does it contain structured, consistently formatted recent history?
• Are instructions for contributing included (CONTRIBUTING.md)?
• Are installation instructions clearly written in the README and tested on a clean machine?
• Are all dependencies described in the README, requirements.txt, and/or buildout.cfg?
• Are the API docs generated?
• Are there unit tests?
• If applicable and possible, is it set up in TravisCI?
• Have multiple people reviewed the code?
• Is there a screenshot in the README, if applicable?

[zwergius]

Checklist grabbed from: https://github.com/cfpb/open-source-project-template/blob/main/opensource-checklist.md

[mickeyjoes]

Updated checklist