Checklist

Steps you need to follow to create a public repo and make sure it is secure

If you need to make a public repo, this quick start guide is for you. Please meet with Frank Aragona DOH.CDS.GenSeqSurvDQ@doh.wa.gov before creating a public repo.

Checklist

• Submit a request (service central ticket) to join a public GitHub organization
• Review items that are prohibited from being in a repo
• Add security guardrails
• Create global security hooks for all your repos
• Make a private staging repo to make sure everything is clean
• Perform secret scanning on your repo
• Add a license
• Make branch protections
• Copy over the cleaned main branch from private repo into new public repo
• Add a README and consider adding a Github page for documentation

Access

Our organization has several public Github orgs. If you are internal to Washington State Department of Health, you will need to submit a Service Central Request for access. Please reach out to frank.aragona@doh.wa.gov for help.

Github Security

Please read all of the security guidelines here

The guide will go over

• what data/code is not allowed in a public repo
• security layers you need to prevent leaks
• converting private code to public repositories
• installation of pre-commit hooks to prevent leaks

Building a Public Repo

If you have an existing private repo that needs to be public, please follow these steps:

• repo cleaning guides
• code scanning

Licensing

• license rules

Repo tips/advice

• org policies
• make your repo reproducible
• repo documentation
• virtual environments
• git/github help, and how to collaborate on a repo