search

DSACMS / ospo-guide

Open Source Program Office Guide for CMS.gov
Creative Commons Zero v1.0 Universal
6 stars 1 forks source link

Archiving Repos #9

Open natalialuzuriaga opened 4 months ago

natalialuzuriaga commented 4 months ago

Issue Report

Create guidance for when to consider publicly archiving a repository.

Expected behavior

We are lacking a list of criteria for when a repository should be considered for archival as part of our regular reviews of the ecosystem of DSACMS (and broadly CMS Open Source) projects.

Actual behavior

Let's do so research, find some examples of best practices from other government agencies, as well as private sector best practices, and draft a candidate process!

decause-gov commented 4 months ago

https://github.com/todogroup/guides/blob/master/shutting-down-an-open-source-project.md https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories

Additionally, a general-rule that is often used is that if a project is inactive for >2 years, it should be considered for archival. There is a difference between a 'stable' project (that hasn't had many updates because it is mostly 'complete') and a project that is without contributions, so we don't recommend automatically archiving based solely on an activity metric.

There is also guidance to be provided around 'Stable' projects as well, such as enabling dependabot, doing annual reviews, or having a backlog of 'good-first-issues' that will entice future development, if that is part of your project goals.