README.md

github-ospo

Helping open source program offices (OSPOs) get started

The purpose of this repo is to enable new OSPOs to be successful on GitHub. On behalf of the GitHub OSPO we are sharing our policies, tools, and best practices to guide you through the first 6-12 months of your organization's open source journey. There are also other OSPO guides and resources available through TODO & OSPO Alliance as well as opensource.guide. This repo will focus on GitHub related tools and content.

Adopting and adapting

Feel free to use, modify, and adopt these policies, procedures, and guides. They are open source! 🎉 If you are adopting them, run through and do a quick search for the following:

• XXX
• <COMPANY_NAME>
• <LEGAL_CONTACT>
• <OPEN_SOURCE_MAILBOX>

We have used those as placeholder values where our policies point to internal only documentation, internal teams, or to GitHub as a company rather than the product. Also search for the @ so that you can update any email addresses with the proper ones for your company.

Directory

• Policies
  • Releasing open source steps
  • Releasing open source policy
  • Contributor license agreements
  • License compliance
  • Small code exceptions
• Guides
  • Archiving repos
  • Understanding open source health metrics
  • Sponsoring Open Source
  • OSPO Tools & External Guides
  • Commercial licenses
  • Maximize your open source presence on GitHub
  • Measuring maintainer responsiveness and issue metrics
  • Gaining insights into your contributors
  • Managing dependencies at scale
  • Keeping repository maintainer information accurate
• Misc
  • Internal OSPO newsletters

Tools Created by GitHub OSPO

GitHub Actions

In addition to the information in this repository, we've also released a number of GitHub Actions that can help OSPOs track activity, clean house, and automate other useful activities. The actions are released in separate repos but are all linked here for convenience.

• github/contributors - Given an organization or repository, produces information about the contributors over the specified time period.
• github/evergreen - Enable automated security updates and open a issue/PR in repos in an org that have dependency files but no dependabot.yaml file
• github/issue-metrics - Gather metrics on issues/prs/discussions such as time to first response, count of issues opened, closed, etc.
• github/stale-repos - Identify and report on repositories with no activity for configurable amount of time, in order to surface inactive repos to be considered for archival
• github/cleanowners - A GitHub Action to suggest removal of non-organization members from CODEOWNERS files
• github/automatic-contrib-prs - Automatically open a pull request for repositories that have no CONTRIBUTING.md file

GitHub Apps

• github-community-projects/private-mirrors - A GitHub App that allows you to contribute upstream using a "private fork"

Maintainers

GitHub OSPO team

Contributions

We welcome all contributions. Please open an issue in the repo or fork, edit, and open a pull request.

License

This repo is licensed under MIT for code and CC BY-SA 4.0 for documentation.