This is a review process to approve CMS-developed software to be released open source. If you would like your repository to be released, please complete the following steps.
State the Benefits of Open Sourcing the Project
State the Risks of Open Sourcing the Project
Sign off on risk acceptance of open-sourcing the software product
Flipping the Switch: Making the Repository Public
-
Cost Savings
By making the project freely available, this reduces licensing and acquisition costs.
-
Ease of Repurposing
The open nature of the code allows users to modify and adapt the software to suit their specific needs, fostering customization and flexibility.
-
Minimization of Vendor Lock-in/Flexibility of Vendor Choice
Users are not tied to a single vendor, providing the freedom to choose between different vendors.
-
Enable Transparency
The source code is accessible and visible to anyone, promoting transparency in how the software functions, which helps build trust.
-
Enable extension/extensibility
Users can extend and enhance the functionality of the software by adding their own features.
-
Increase Interoperability
Planning in the open enables future compatibility and interoperability between different systems and software applications.
-
Facilitate Experimentation/Early Adoption
Working in the open encourages experimentation and early adoption of cutting-edge technologies, leading to faster innovation and improvement in software capabilities.
-
Security Risks
Vulnerabilities may be exposed if the code is not thoroughly reviewed, potentially leading to security breaches or exploitation. (See: SECURITY.md) Does this project connect to any CMS-internal only systems? Does this project require authorization or authentication to operate? Does this project detail any non-public directories of CMS/HHS systems or people?
-
Financial Risks
Costs may arise from maintaining code, community engagement, addressing security concerns, subscription costs, hardware costs, specialized tooling or infrastructure costs among others. Does this project require any ongoing financial costs or subscription fees? (e.g., Cloud Hosting, Specialized build systems, paid maintainers, paid libraries or dependencies.)
-
Privacy Risks
Does this project require access to non-public, non-synthetic PII, PHI, or other internal-only CMS systems containing such data or information?
-
Does the code contain or touch any private information such as Personal Identifiable Information (PII) or Protected Health Information (PHI)?
- Can it be removed? Is it absolutely needed to function? Can it be shipped with synthetic data instead?
-
Does the code interface with any of CMS’ internal-only systems (e.g. mainframes, JIRA instances, databases, etc…)?
-
Does the repository contain any keys or credentials to access or authenticate with CMS’ systems?
- Can it be removed or is it needed?
If you answered “yes” to any of the above questions, your project may be ‘sensitive’ in nature, and require a more thorough review before sharing publicly. Please reach out to [email protected] for guidance. If you answer yes to any of these questions above, it is best to seek guidance before releasing open source.
Insert Review Here
The existing codebase should be given a one time, top-to-bottom code quality and security vulnerability review by two (or more) engineers who have written production code within the past two years, in the languages used in the project Engineers should review credential management practices with the development team to ensure that any keys, passwords, or other sensitive configurations are not checked into source code or in the git history.
The engineers can be federal government employees or trusted partners from outside the agency from other contracts, or from independent testing contracts. Their names, organizations, comments and approval/disapproval on the overall codebase should be tracked in this document.
To provide independent review, ideally the engineers should not have been involved in the development of the software product. This includes engineers who wrote part of the software or who directly provided technical direction and oversight in the creation of the software.
As part of the code review, engineers should reference modern listings of the most significant software security vulnerabilities. For instance, an acceptable description would be that the engineers showed how they used automated tools and manual review to check each item in OWASP's current 10 Most Critical Web Application Security Risks.
Insert Review Here
A best practice and a requirement for releasing a repository open source at many parts of CMS is to run at least one automated tool for code analysis (such as static code analysis, repolinters, secret scanners) on the codebase to detect for security vulnerabilities or sensitive information, and results have been appropriately addressed. Even if all findings are eventually fixed, if the initial scans revealed significant, severe vulnerabilities(such as SQL injection vulnerabilities), this may indicate that the software development team was not adhering to the best practices required for open source public release, and should be given additional review.
Ideally, automated tooling for code analysis should be incorporated as a regularly scheduled part of the software development lifecycle. The development team should briefly document how frequently they commit to running these automated scanning tools, and how they will be running these tests, and who will be monitoring, interpreting, and acting upon the results.
Below is a list of suggested tools to run for code analysis:
| Tool | Description | Link |
|---|---|---|
| Repo Linter | Lint repositories for common issues such as missing files etc. | https://github.com/todogroup/repolinter |
| gitleaks | Protect and discover secrets using Gitleaks 🔑 | https://github.com/gitleaks/gitleaks Use and run gitleaks.yml provided in repository |
| git filter-repo | Entirely remove unwanted files / files with sensitive data from a repository's history | https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository |
Insert Review Here
Ensure that acceptable licensing is decided for the project. Most often, software released as open source by the federal government does so under the Creative Commons Zero 1.0 license.
Suggested licensing:
Public Domain
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
If your project is not being dedicated to the public domain under CC0, due to being work for hire, or some other documented reason, then choosing another OSI approved license is the next best thing.
Insert Review Here
Review the history of commits to the version control system used, and whether the team prefers to clean (e.g.,rebase) this history before releasing to the public.
If not rebasing, verify that:
- There are no obscene or impolite remarks in comments or commit history
- There are no sensitive internal URLs/IP addresses in comments or commit history
- There are no credential files such as passwords, API/SSH/GPG keys checked into the repo
Consider using the following tools to perform the tasks above:
| Tool | Description | Link |
|---|---|---|
| gitleaks | Open source tool that detects and prevents secrets (passwords/api/ssh keys) checked-in to your git repo | https://github.com/gitleaks/gitleaks https://akachandwani.medium.com/what-is-gitleaks-and-how-to-use-it-a05f2fb5b034 Use and run gitleaks.yml provided in repository |
| git filter-repo | Entirely remove unwanted files / files with sensitive data from a repository's history | https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository |
Insert Review Here
As part of our repository hygiene requirements, the project must include certain files and sections. Using repolinter will help identify missing files and content that will need to be added to your repository before outbounding.
-
Add repolinter.json to the root directory of your project
-
Run command:
repolinter lint .
- The result produces a list of files section existence checks, indicating whether each requirement was met or not.
-
Add the tier-specific checks.yml to the github directory of your project. The file includes a job that runs a repolinter called repolinter-checks
-
Manually trigger the workflow
-
The results produces an issue on the repository with a list of file and section existence checks, indicating whether each requirement was met or not
The project should include the following files and sections (link to template):
-
README.md
An essential guide that gives viewers a detailed description of your project
| Section | Description | Included |
|---|---|---|
| Project Description | 1-3 sentences short description of the project that can be used as a 'one-liner' to describe the repo. A best practice is using this same language as the official 'description' on GitHub repo landing page. | ✅ ❌ |
| About the Project | Longer-form description of the project. It can include history, background, details, problem statements, links to design documents or other supporting materials, or any other information/context that a user or contributor might be interested in. | |
| Core Team | This information helps with succession planning and provenance for security compliances and remediation. It helps future users and contributors understand where the code originated. | |
| Policies | This section is to explicitly link to Federal policies and guidelines that are required or rocommended for Federal projects to comply with, such as Accessibility (508) Interoperability, Anti-deficiency, Security, Licensing, and other policies that can vary between agencies and domains. | |
| Public Domain | A best practice is to list the LICENSE under which a project is released at the bottom of the README. In most cases for Federal repos, we default to Creative Commons Zero 1.0 International(world-wide public domain.) |
-
LICENSE
License of your project, whether public domain (CC0) or other OSI-approved License. Using ‘vanilla’ license text will allow for GitHub to auto-label the license information on the repository landing page.
-
CONTRIBUTING.md
Provides guidance on how users can run your project and make contributions to it
| Section | Description | Included |
|---|---|---|
| Getting Started | Included installations steps, prerequisites for installation, and instructions for working with the source code | |
| Building Dependencies | This step is often skipped, so don't forget to include the steps needed to install on your platform. If your project can be multi-platform, this is an excellent place for first time contributors to send patches! | |
| Building the Project | Be sure to include build scripts and instructions, not just the source code itself! | |
| Writing Issues | Make a brief statement about where to file issues, and conventions for doing so. | |
| Policies | This section is here to explicitly link to Federal policies and guidelines that are required or recommended for Federal projects to comply with, such as Accessibility (508) Interoperability, Anti-deficiency, Security, Licensing, and other policies that can vary between agencies and domains. | |
| Public Domain | This section is to explicitly link to Federal policies and guidelines that required or recommended for Federal projects to comply with, such as Accessibility (508) Interoperability, Anti-deficiency, Security, Licensing, and other policies that can vary between agencies and domains. |
-
repolinter.json
Lints repository for missing files and sections above
-
code.json
Contains metadata about the project, refer to Review Project Metadata
As you are writing content about the repository, consider the following when describing the project, the agency, and how work is done:
- Focus on solutions, not problems Rather than describing the negatives and shortcomings of an existing project, process, or group, focus on highlighting the benefits, outcomes, and positive impacts of the solution. Be constructive and accentuate the positive.
- Use Plain Language Be clear and concise when explaining concepts. Avoid jargon unless it is necessary and well-defined. Use active voice to be clearer and more engaging.
- Focus on the audience Write for a broad audience, ensuring that developers, stakeholders, end-users, and viewers of all skill levels can understand and engage with the content.
Please refer to the style guides below for additional tips and guidance:
- CMS Resources
- 18F Style Guide
- UK Content Style Guide
Insert Review Here
As part of the Federal Source Code Policy and the agency’s software inventory tracking initiatives, each repository must contain a code.json file, storing metadata on your project.
Creating code.json on your repository
- In the
.githubdirectory, run the command:
cookiecutter . –directory=codejson
-
Answer various questions about your project.
-
A code.json file will be generated with your responses.
Please keep this file up-to-date as you continue development in this repository. The OSPO is currently developing workflows to help assist with this work.
Insert Review Here
The GitHub repository homepage features a concise description of the project, a list of relevant topic tags, and general information about the repository to provide a comprehensive overview for users and contributors.
About Section:
-
Description
1-2 sentences describing the project
-
Website
Link to project’s website
-
Topics
Tags for project discoverability. Helpful topics to classify a repository include the repository's intended purpose, subject area, community, or language.
Include in Home Page:
- Releases
- Packages
- Deployments
Insert Review Here
Insert any notes or questions here
After reviewing the materials prepared by the team that is working to open source the product, the business owner signs off on a risk acceptance for open-sourcing the software product.
Requesting sign off from key people on this request.
| Reviewer Organization | Reviewer Name | Reviewer's Recommendation |
|---|---|---|
| Code Reviewer's Recommendation | CODE REVIEWER 1 CODE REVIEWER 2 CODE REVIEWER 3 | [Approved/Needs Approval] [Approved/Needs Approval] [Approved/Needs Approval] |
| ISSO | ISSO REVIEWER | [Approved/Needs Approval] |
| ISG Technical Approval | ISG REVIEWER | [Approved/Needs Approval] |
| Business Owner(s) | BUSINESS OWNER 1 BUSINESS OWNER 2 | [Approved/Needs Approval] [Approved/Needs Approval] |
Once the repository has passed outbound review, we are ready “flip the switch” and officially make it public. Once made public, there are a couple of actions that need to be taken:
Please enable the following features to enhance repository security and maintain code quality:
-
Dependabot Alerts
A GitHub Feature. Get notified when one of your dependencies has a vulnerability
-
Secret Scanning Alerts
A GitHub Feature. Get notified when a secret is pushed to this repository. Ideally set this up to run after each new commit is pushed to the Repository.
-
Branch Protections
Ensures the integrity of important branches by preventing unauthorized actions like force pushes and requiring pull request reviews with specific checks before merging. Dev and main should be protected branches in the repository.
-
Git Branching
After making the repository public, make sure there is a coherent git branching plan in place. For example: agree to merge feature related pull requests into dev but merge bug fixes into main instead of dev first.
-
Add Repolinter GH Action to CI
For ongoing adherence to repository hygiene standards, integrate the repolinter GitHub Action into your CI pipeline. This addition enhances your workflow by automatically enforcing repository cleanliness standards.
-
Optional: DCO (Developer Certificate of Origin)
Requires all commit messages to contain the Signed-off-by line with an email address that matches the commit author. The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. The GitHub app to enforce DCO can be found here .
Share the good news with communities both inside and outside CMS!
- Draft a launch announcement
Be sure to include the following information:
-
Repo Description
- Repo URL
- Authoring Team Email Contact
- Authoring Team URL
- Authoring Team Slack Channel
- Call to action (File issues, contribute PRs)
-
Post launch announcement to CMS slack channel
- #cms-opensource
- #cms-api-community
- #cms-data-community
- #cms-engineering-community
- #ai-community
-
Send a launch announcement email
-
Add launch announcement to a Confluence Wiki Page
Add your project to our inventories.
-
Add to https://github.com/dsacms/open projects inventory
-
Add code.json to repository and sent over a pull request to code.gov