To maximize the quality of DC’s open source code and to encourage contributions and reuse by the community, it is important for teams to clearly and consistently document their work.
18F, a digital consultancy within the U.S. General Services Administration, has developed an excellent set of guidelines for documenting GitHub-based projects, which the DC Government teams should use as a reference.
Committing records changes made to a Git repository.
A fork is a copy of someone else’s Git repository. You can make changes to your fork without affecting the original project.
Git is a popular free and open source system for tracking changes in text-based files. It is primarily used for software development.
GitHub is a web-based platform on which you can host and work on Git repositories. It provides a number of useful features, including bug tracking, feature requests, and task management.
In brief, open source licenses allow software to be freely used, modified, and shared. They abide by standards laid out in the Open Source Definition.
PII is any information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context.
Private keys are a kind of PII used to decrypt messages sent over the Internet. They form part of a system called Public-Key Cryptography.
Pushing allows you to share the Git commits you have made with others.
Repositories are places where a Git project’s files and their revision history are stored.
A software token can be used in two-factor authentication to authorize access to computer services.
In two-factor authentication, two different components are used in combination to verify a user’s identity (e.g. a password and a single-use token sent to your email).
