Welcome! This repository is an information only project to act as a collection point for all Code.gov repositories.
Code.gov is a website and program promoting good practices in code development, collaboration, and reuse across the U.S. Federal Government. Code.gov provides tools and guidance to help federal agencies implement the Federal Source Code Policy. It includes an inventory of the federal government's custom code to promote reuse between federal agencies. Also, Code.gov provides tools to help the government and the public collaborate on open source projects.
You can read the original White House Federal Source Code Policy announcment and Code.gov announcement archives.
All Code.gov repositories are open source, we invite your contributions be it in the form of code, design, issues, or ideas.
As a product, Code.gov is a collection of repositories that enable the aggregation of source code inventory files. All of our work is open source and we encourage you to take a look and, if you wish, contribute to our projects by submitting a pull request, a Github Issue, or commenting on existing issues and pull requests. If you are unsure as to where an issue should live, please use the GSA/code-gov repo as a catch all.
All of our repositories follow our Code of Conduct and Contributing guidelines.
These repos are all used to maintain Code.gov
General documentation
| Project | Description | Issues | New Issue |
|---|---|---|---|
| GSA/code-gov | (This repo) An information only project to act as a collection point for all Code.gov repositories. | View all issues | |
| GSA/code-gov-open-source-toolkit | This is a government-wide project facilitated by the Code.gov team to produce a playbook and toolkit pertaining to open sourcing software (OSS). | View all issues | Create a new issue |
| GSA/code-gov-repo-template | A basic template to use when creating new code.gov repositories. It includes our standard documents and contact info. Using this as a base ensures that all of our community standards are followed. | View all issues | Create a new issue |
Front-end - repositories related to user-facing interactions for the platform
| Project | Description | Issues | New Issue |
|---|---|---|---|
| GSA/code-gov-front-end | Our frontend project, currently deployed as a static site which renders Code.gov, this project is backed by our API to display project repositories, search, and an agency compliance dashboard. | View all issues | Create a new issue |
| GSA/code-gov-api-client | Client for Interacting with Code.gov API | View all issues | Create a new issue |
| GSA/code-gov-font | Custom font with icons used by the Code.gov front end. | View all issues | Create a new issue |
| GSA/code-gov-style | Our effort to modularize our CSS styles. This project is also made available as a NPM package and jekyll site. | View all issues | Create a new issue |
| GSA/json-schema-web-component | Web Component that Displays a JSON Schema consumed by the front end | View all issues | Create a new issue |
| GSA/json-schema-validator-web-component | Web Component that Displays a JSON File and Validates it based on a Schema | View all issues | Create a new issue |
| GSA/code-gov-data | Data Files used by code.gov | View all issues | Create a new issue |
| GSA/compliance-dashboard-web-component | Reusable compliance dashboard web component | View all issues | Create a new issue |
| GSA/cautious | Cautious Utility Functions in JavaScript for code.gov | View all issues | Create a new issue |
| GSA/code-gov-site-map-generator | Generates Sitemap.xml for Code.gov | View all issues | Create a new issue |
Back-end - repositories related to data harvesting and delivery for the platform
| Project | Description | Issues | New Issue |
|---|---|---|---|
| GSA/code-gov-api | Our backend API. An Express.js app backed by Elasticsearch. Its primary function is to index and make America's source code discoverable and searchable. | View all issues | Create a new issue |
| GSA/code-gov-harvester | Our standalone source code inventory harvester. | View all issues | Create a new issue |
| GSA/code-gov-adapters | Our attempt to extract all data adapters into a simple reusable project. Currently only an Elasticsearch adapter has been implemented but more are on our roadmap. This project is also made available as a NPM package | View all issues | Create a new issue |
| GSA/code-gov-integrations | This project contains all of our third party integrations. Currently Github integration is the only one implemented but more are on our roadmap. This project is also made available as a NPM package | View all issues | Create a new issue |
| GSA/code-gov-validator | Schema validation package for Code.gov. This project is still a work in progress and is not ready for use. | View all issues | Create a new issue |
Tools - projects we have created in order to better aid our work on the code.gov platform. They do not affect the development or deployment of our main repos
| Project | Description | Issues | New Issue |
|---|---|---|---|
| GSA/code-gov-verify-agency-jsons | This a utility project, used in conjustion with code-gov-harvester, can help you find various statistics of Repositories imported into code.gov system. | View all issues | Create a new issue |
| GSA/code-gov-converter | Converts publiccode.yml to code.json. | View all issues | Create a new issue |
| GSA/code-gov-repo-template | A basic template to use for all code.gov repositories which includes our standard documents and contact info. Using this as a base ensures that all of our community standards are followed. | View all issues | Create a new issue |
| GSA/code-gov-github-metrics | This project compiles and calculates GitHub metrics across the different repos that make up code.gov so that the code.gov team can understand and track community contributions and other data points over time. | View all issues | Create a new issue |
| GSA/code-gov-open-source-toolkit | This is a government-wide project facilitated by the Code.gov team to produce a playbook and toolkit pertaining to open sourcing software (OSS). | View all issues | Create a new issue |
Deprecated/inactive repositories - repos were previously used by the code.gov team but have been deprecated and/or are no longer in use
| Project | Description | Reason for deprecation |
|---|---|---|
| GSA/code-gov-web | The old version of the Code.gov front end | The front end stack was changed from Angular to React. The new front end repo is GSA/code-gov-front-end. |
| GSA/code-gov-harvester-deprecated | The old version of the harvester that harvests and processes code.json files from agencies. | The new harvester repo is GSA/code-gov-harvester. |
| GSA/code-gov-about-page | Component for the About page on Code.gov. | The about page component was integrated directly into GSA/code-gov-front-end in order to simplify the site architecture. |
| GSA/code-gov-fscp-react-component | Federal Source Code Policy (FSCP) plugin for code-gov-front-end, built with Markdown and React. | The FSCP is hosted at https://sourcecode.cio.gov/ and it was therefore duplicative for it to be on Code.gov as well. |
| GSA/code-gov-admin-backend | This repository contains the source code for backend of the Code.gov Admin Tool. | The Admin Tool is no longer in use. |
| GSA/code-gov-admintool | This repository contains the source code for the frontend of the Code.gov Admin Tool. | The Admin Tool is no longer in use. |
| GSA/code-gov-repos-parser | Parse out information from code.gov repos. | The project is no longer in use. |
| GSA/code-gov-coding-languages | Standard List of Coding Languages used by Code.gov. | The project is no longer in use. |
| GSA/code-gov-data-quality-poc | Code.gov data quality scoring proof of concept. | The project was a proof of concept and is no longer in use. |
| GSA/code-gov-gitsecretpatterns | Repository for Code.gov git-secrets patterns and bootstrap script. | The project is no longer in use. |
| GSA/code-gov-stats | A simple app to extract stats about repositories using the Github API and Cloc | The project is no longer in use. |
| GSA/code-gov-developer-docs | Our developer docs! This repo is meant to be a simple way to start using our API. | Documentation is now hosted at https://open.gsa.gov/api/codedotgov/ |
| GSA/code-gov-stats-jupyter-notebook | Extract some stats for Code.gov using the Github GraphQL API. | Repo no longer in use for pulling Code.gov stats. |
- code_json_generators.md: A comparison table of code.gov generator/scraper tools
- data_quality_scoring.md: Info on how the code.gov data quality scores are determined
- front_end_guidelines.md: General guidance to follow when developing on the front end
- help_wanted.md: Detailed info on our Open Tasks (formerly Help Wanted) and the labels projects need to use in order to display these on code.gov
- infrastructure.md: This files describes the infrastructure, server space and memory, required to run code.gov. It breaks down the server requirements by front-end and different back-end processes
- labor_hour_calc.md: Guidance on how agencies can calculate labor hours on open source projects
- metadata_examples.md: A showcase of good examples of metadata in current agency code.json files
- procedures.md: Administrative procedures for the code.gov team
- repo-labels.json: A json file that can be used to add the specific GitHub issue labels code.gov uses on their projects
- repository_management.md: This is a living document explaining how we collaboratively manage the Code.gov platform repositories
- CoPMeetingMins: This is a folder containing the notes from our monthly Community of Practice meetings
If you have questions, please feel free to contact us:
- Open an issue
- Join our
#opensource-publicchannel on Slack: https://chat.18f.gov/