CDC open practices

[leebrian]

Hello, CDC recently established common practices for open source projects that call out a few required and recommended practices for all CDC projects.

Would you please update your project for these items?

• [x] Set a meaningful project topics to improve discovery and use of your project.
• [x] Assign an open source license based on program need. For guidance on licenses, please review the article, "Open Source Development for Public Health Informatics", refer to existing CDCgov projects, or ask for consultation support in choosing a license.
• [x] Include the required notice sections in your readme.md to comply with relevant CDC policies and procedures, adapt as necessary based on your program need.
  • [x] Public Domain Standard Notice
  • [x] License Standard Notice
  • [x] Privacy Standard Notice
  • [x] Contributing Standard Notice
  • [x] Records Managing Standard Notice
  • [x] Additional Standard Notices
• [x] Enable GitHub Automated security alerts and configuring notification for the repo admin to see and respond to these alerts.
• [ ] If active, configure GitHub automated security alerts and respond to them in a timely manner. Projects that do not respond to security alerts will have issues raised in their project by admins.

[WendyBlumenthal]

Thank you for the input. We have set up the project name and description, and are working on the security alerts and required notices. We have 1 follow up questions about the open source: would the Apache 2.0 license be the correct one to use? Thanks, Wendy

[leebrian]

Thanks Wendy. The specific license depends on your needs. Most projects choose Apache 2.0, so that's the default one I recommend unless you need something different.

[WendyBlumenthal]

Thanks Brian. We added the Apache 2.0 license. One more question: We've set up a project name and description, but don't know where/how to set up "topics". Can you provide some assistance with this?

[leebrian]

Thanks for working on this. It helps both your partners use your project, and other projects at CDC figure out how to better use these practices.

At the top of the project, under the description, there's a link called "manage topics" Please click on that and add a few tags that will help organize your project amidst other projects on CDCgov and help people find and use your work.

Here's a screenshot of where to click...

Here's GitHub's docs on topics...https://help.github.com/en/github/administering-a-repository/classifying-your-repository-with-topics

Here's how the topics look when picked up by code.gov...