CNCF Sandbox Application

Project name: Replace with your project name

Official CNCF application issue: Filled in automatically when you run ./scripts/generate-submission.sh --create-issue

Checklist issues: Run ./scripts/bootstrap-issues.sh after creating your repo from this template.

This repository helps you prepare a CNCF Sandbox application.

Edit APPLICATION.md only for checklist answers and form content. This README shows progress and mirrors checklist issue/PR links (updated by automation).

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. Commit bootstrap changes and push.

4. Work in APPLICATION.md only:

   1. complete Your answer section
   2. Open a PR with Closes #N (issue link is on the checklist line)
   3. make sure you add the proper field_id to Application fields updated section: e.g. project_summary, maintainers_file.

5. When every item is complete:

   ./scripts/generate-submission.sh --validate
   ./scripts/generate-submission.sh --create-issue

   You do not need to sync the CNCF form while working. At submit time, generate-submission.sh checks the live CNCF application template and maps your APPLICATION.md answers onto it.

See CONTRIBUTING.md for the full workflow.

How tracking works

Stage	Checklist line shows
After bootstrap	- [ ] … (Issue: [#N](…))
After you open a PR with Closes #N	- [x] … (PR: [#M](…)) in APPLICATION.md and this README
After the PR merges	Issue closes; progress on main matches

Application progress

Application progress: 0 / 29 items complete (0%)
░░░░░░░░░░░░░░░░░░░░ 0%

Application checklist

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

read_prerequisites

• Reviewed all prerequisite documentation (Issue: #ISSUE_READ_PREREQUISITES)

project_summary

• Project summary and description drafted (Issue: #ISSUE_PROJECT_SUMMARY)

project_description

not_reference_architecture

• This is a reusable open source project designed for broad adoption, not a reference architecture, reference implementation, or demonstration of patterns (Issue: #ISSUE_REUSABLE_PROJECT)

org_repo_url

• Org and repository URLs documented (Issue: #ISSUE_ORG_AND_REPO_URLS)

project_repo_url

additional_repos

website_url

• Website URL documented (Issue: #ISSUE_WEBSITE_URL)

roadmap

• Roadmap and context documented (Issue: #ISSUE_ROADMAP)

roadmap_context

contributing_guide

• Contributing guide linked (Issue: #ISSUE_CONTRIBUTING_GUIDE)

code_of_conduct

• Code of Conduct linked (Issue: #ISSUE_CODE_OF_CONDUCT)

adopters

• Adopters list linked or rationale documented (Issue: #ISSUE_ADOPTERS)

maintainers_file

• MAINTAINERS file created with required columns (Issue: #ISSUE_MAINTAINERS_FILE)

security_policy

• Security policy linked (Issue: #ISSUE_SECURITY_POLICY)

standard_or_spec

• Standard/specification details documented (Issue: #ISSUE_STANDARD_OR_SPEC)

product_separation

• Business product/service separation documented (Issue: #ISSUE_PRODUCT_SEPARATION)

why_cncf

• Why CNCF drafted (Issue: #ISSUE_WHY_CNCF)

landscape_benefit

• Landscape benefit drafted (Issue: #ISSUE_LANDSCAPE_BENEFIT)

cloud_native_fit

• Cloud native fit drafted (Issue: #ISSUE_CLOUD_NATIVE_FIT)

cloud_native_integration

• Cloud native integration drafted (Issue: #ISSUE_CLOUD_NATIVE_INTEGRATION)

cloud_native_overlap

• Cloud native overlap drafted (Issue: #ISSUE_CLOUD_NATIVE_OVERLAP)

similar_projects

• Similar projects documented (Issue: #ISSUE_SIMILAR_PROJECTS)

landscape

• Landscape listing status documented (Issue: #ISSUE_LANDSCAPE_LISTING)

insights

• LFX Insights status documented (Issue: #ISSUE_LFX_INSIGHTS)

trademark_agreement

• If the project is accepted, I agree to donate all project trademarks and accounts to the CNCF (Issue: #ISSUE_TRADEMARK_AGREEMENT)

ip_policy_agreement

• If the project is accepted, I agree the project will follow the CNCF IP Policy (Issue: #ISSUE_IP_POLICY_AGREEMENT)

license_exception

• License exception review completed (Issue: #ISSUE_LICENSE_EXCEPTION)

dependency_licenses

• Dependency license compliance verified (Issue: #ISSUE_DEPENDENCY_LICENSES)

domain_technical_review

• Domain Technical Review linked (if applicable) (Issue: #ISSUE_DOMAIN_TECHNICAL_REVIEW)

application_contact_emails

• Application contact emails and signatory information completed (Issue: #ISSUE_CONTACT_INFORMATION)

signatory_information

cncf_contacts

• CNCF contacts and additional information completed (Issue: #ISSUE_ADDITIONAL_INFORMATION)

additional_information

final_review

• Final review complete and application submitted to CNCF (Issue: #ISSUE_FINAL_REVIEW)

References

• CNCF Sandbox repository
• CNCF Project Lifecycle & Process
• CNCF Sandbox Application Form

License

Apache License 2.0 — see LICENSE.