Skip to content

Open Source Check List #4

@zwergius

Description

@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?

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions