CNCF Sandbox Onboarding

Project name: Replace with your project name

CNCF onboarding issue: Link to your project's onboarding issue in cncf/sandbox

Accepted (TOC vote): YYYY-MM-DD

Target completion (accepted + 30 days): YYYY-MM-DD

This repository helps you track and complete CNCF Sandbox onboarding after your project's TOC acceptance vote. CNCF asks projects to complete onboarding within one month of acceptance.

Edit ONBOARDING.md only for evidence and checklist items. This README shows progress and mirrors checklist status (updated by automation).

Onboarding progress

Onboarding progress: 0 / 36 items complete (0%)
░░░░░░░░░░░░░░░░░░░░ 0%

Onboarding checklist

Each row links to the matching section in ONBOARDING.md. A PR with Closes #N checks the box and switches (Issue: …) to (PR: …) automatically — do not edit these lines by hand.

• ⬜ Review and understand the CNCF IP Policy (Issue: #ISSUE_IP_POLICY_REVIEW)
• ⬜ Review and understand the CNCF Third Party License Policy (Issue: #ISSUE_LICENSE_POLICY_REVIEW)
• ⬜ Review and understand the LF trademark guidelines (Issue: #ISSUE_TRADEMARK_GUIDELINES_REVIEW)
• ⬜ Transfer trademark and logo assets to the Linux Foundation (Issue: #ISSUE_TRADEMARK_TRANSFER)
• ⬜ Review the Technical Leadership Principles (Issue: #ISSUE_TECHNICAL_LEADERSHIP_PRINCIPLES)
• ⬜ Review the project proposal process and requirements (Issue: #ISSUE_PROJECT_PROPOSAL_PROCESS)
• ⬜ Review services available for your project at the CNCF (Issue: #ISSUE_CNCF_SERVICES_REVIEW)
• ⬜ Review the online program guidelines (Issue: #ISSUE_ONLINE_PROGRAM_GUIDELINES)
• ⬜ Review the telemetry data collection and usage policy (Issue: #ISSUE_TELEMETRY_POLICY_REVIEW)
• ⬜ Optional: book time with CNCF staff (Issue: #ISSUE_CNCF_STAFF_OFFICE_HOURS)
• ⬜ Move the project to its own separate neutral GitHub organization (Issue: #ISSUE_NEUTRAL_GITHUB_ORG)
• ⬜ Accept the invite to join the CNCF GitHub Enterprise account (Issue: #ISSUE_GHE_INVITE_ACCEPTED)
• ⬜ Migrate Slack channels to the Kubernetes or CNCF Slack workspace (Issue: #ISSUE_SLACK_MIGRATION)
• ⬜ Join the #maintainers-circle Slack channel (Issue: #ISSUE_MAINTAINERS_CIRCLE_SLACK)
• ⬜ Transfer project domain(s) to the CNCF (Issue: #ISSUE_DOMAIN_TRANSFER)
• ⬜ Submit a pull request with your artwork (Issue: #ISSUE_ARTWORK_PR)
• ⬜ Transfer website analytics to the CNCF (Issue: #ISSUE_ANALYTICS_TRANSFER)
• ⬜ Create a maintainer list and add it to the aggregated CNCF maintainer list (Issue: #ISSUE_MAINTAINER_LIST_PR)
• ⬜ Provide maintainer emails for mailing list and Service Desk access (Issue: #ISSUE_MAINTAINER_EMAILS)
• ⬜ Ensure the DCO app is enabled for all project GitHub repositories (Issue: #ISSUE_DCO_ENABLED)
• ⬜ Reference the CNCF Code of Conduct in README.md (Issue: #ISSUE_COC_IN_README)
• ⬜ Add the LF footer to your website (or README if no website) (Issue: #ISSUE_LF_FOOTER)
• ⬜ Start a GOVERNANCE.md documenting open governance (Issue: #ISSUE_GOVERNANCE_DOC)
• ⬜ Start a SECURITY.md security policy (Issue: #ISSUE_SECURITY_DOC)
• ⬜ Start an OpenSSF Best Practices Badge (Issue: #ISSUE_OPENSSF_BADGE)
• ⬜ Import all project repos into a license scanning service (Issue: #ISSUE_LICENSE_SCAN_IMPORT)
• ⬜ CNCF staff: add the project to DevStats (Issue: #ISSUE_DEVSTATS)
• ⬜ CNCF staff: add the project to CLOMonitor (Issue: #ISSUE_CLOMONITOR)
• ⬜ CNCF staff: add the project to LFX Insights (Issue: #ISSUE_LFX_INSIGHTS_ONBOARDING)
• ⬜ CNCF staff: activate the project in the LFX Project Control Center (Issue: #ISSUE_LFX_PCC_ACTIVATION)
• ⬜ CNCF staff: add the project to the Cloud Native Landscape (Issue: #ISSUE_LANDSCAPE_LISTING_ONBOARDING)
• ⬜ CNCF staff: add the maintainers team to the license scanner (Issue: #ISSUE_LICENSE_SCANNER_TEAM)
• ⬜ CNCF staff: create a groups.io project maintainer list in PCC (Issue: #ISSUE_GROUPSIO_LIST)
• ⬜ CNCF staff: add the project's groups.io list to maintainers@cncf.io (Issue: #ISSUE_GROUPSIO_MAINTAINERS_LIST)
• ⬜ CNCF staff: send a welcome email confirming maintainer list access (Issue: #ISSUE_WELCOME_EMAIL)
• ⬜ Final review: confirm all items complete and request sign-off (Issue: #ISSUE_ONBOARDING_COMPLETE)

Quick start

1. Click Use this template to create your own copy of this repository.

2. Clone and bootstrap checklist issues:

   git clone git@github.com:YOUR_ORG/YOUR_REPO.git
   cd YOUR_REPO
   ./scripts/bootstrap-issues.sh

3. Add a CNCF_SANDBOX_TOKEN repo secret (a GitHub PAT with public_repo scope) so Actions can comment on the CNCF onboarding issue on your behalf — see CONTRIBUTING.md.

4. Commit bootstrap changes and push.

5. Work in ONBOARDING.md only: add evidence, open a PR with Closes #N (issue link is on the checklist line). When that issue closes, a progress comment is posted to your CNCF onboarding issue automatically.

See CONTRIBUTING.md for the full workflow.

How tracking works

Stage	What happens
After bootstrap	Checklist line shows - [ ] … (Issue: [#N](…))
After you open a PR with Closes #N	Line becomes - [x] … (PR: [#M](…)) in ONBOARDING.md and this README
After the PR merges (issue closes)	Actions posts a comment with that item on your CNCF onboarding issue — progress becomes visible to CNCF as you go, not just at the end

Some items are labeled [CNCF Staff] — these are completed by CNCF staff, not you. Track them for follow-up and check the box once staff confirms; closing that issue also posts a comment.

Need a one-time full summary instead (e.g. the first update, or to catch up if a comment failed)? Run ./scripts/generate-status-report.sh --post.

References

• CNCF Sandbox onboarding issue this template is based on
• CNCF Sandbox repository
• CNCF project services

License

Apache License 2.0 — see LICENSE.