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.

Sign up for GitHub

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

Jump to bottom

Open Source Check List #4

Open
5 of 13 tasks
zwergius opened this issue Apr 29, 2021 · 2 comments
Open
5 of 13 tasks

Open Source Check List #4

zwergius opened this issue Apr 29, 2021 · 2 comments
Assignees
@mickeyjoes

Comments

@zwergius
Copy link
Member

zwergius commented Apr 29, 2021 •
edited

  • 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 zwergius assigned mickeyjoes and zwergius and unassigned mickeyjoes and zwergius Apr 29, 2021
@zwergius
Copy link
Member Author

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

@mickeyjoes
Copy link
Member

Updated checklist

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mickeyjoes mickeyjoes

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@zwergius @mickeyjoes