DSACMS / DSACMS/testing-repository

Repository Archival Checklist

Open
#90 0 comments 0 reactions 0 assignees View on GitHub
archive
Dominant language
JavaScript
Stars
1
Forks
0
Avg merge
11m
Merged PRs (30d)
1

Description

# CMS.gov Repository Archival Checklist

Use this checklist to ensure all necessary tasks are completed before archiving your repository.

## Repository Metadata
In **code.json**:
- [X] Change status to archival
- [X] Add **archived** to **tags**
- [ ] Review all fields to ensure project metadata is correct and accurate.

## Documentation
- [X] Clearly state at the top the README that the project has been deprecated and will no longer be updated.
- [ ] Include suggestions for alternate projects that provide similar functionality (if applicable).
- [ ] Update all project documentation (wikis, websites, and other documentation)

## Issues Management
- [ ] Review all open issues
- [ ] Close all fixed issues
- [ ] Comment on unresolved issues to provide context
- [ ] Apply appropriate labels to issues
- [ ] Close issues as `won't fix` where applicable

## Security Review
- [ ] Review repository for secrets and keys
- [ ] Check for any Personal Identifiable Information (PII)
- [ ] Remove or redact any sensitive information found

## Repository Access
- [ ] Review and audit committer access permissions
- [ ] Remove access for users who no longer need it

## Cleanup
- [ ] Delete all inactive branches
- [ ] Remove any unnecessary files or artifacts

---

**Note:** Once all items are checked off, the repository is ready for archival.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing code.json and the README against the checklist, then inspect the repository’s other documentation, open issues, security-sensitive content, access permissions, branches, and artifacts. The work is done when each applicable checklist item is completed and the repository is ready for archival.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.