|
1 | 1 | # [Project] Graduation Proposal
|
2 | 2 |
|
3 |
| -_**Insert introduction. See previous proposals for examples. This section should address from a broad perspective why the project feels they are ready to graduation and can state any major accomplishments or milestones.**_ |
| 3 | +## Instructions: |
| 4 | +* replace all `???`s with the requested information. |
| 5 | +* elaborate on any prompt to explain the information provided. Especially if |
| 6 | + the data provided might seem inconsistent when compared to other projects. |
| 7 | +* for any prompt that requires a private answer put `available upon request`. |
| 8 | +* in most cases, the URLs provided should be to resources within the project's |
| 9 | + GitHub repo or website rather than personal or private resources. |
4 | 10 |
|
5 |
| -## Graduation State Criteria |
6 |
| -_**Project should address each graduation criteria listed below**_ |
| 11 | +## Project Summary |
7 | 12 |
|
8 |
| -### * Have committers from at least two organizations. |
| 13 | +1. Name of project: ??? |
| 14 | +1. URL to project website: |
| 15 | + * ??? |
| 16 | +1. URL to GitHub repo: |
| 17 | + * ??? |
| 18 | +1. Project description (e.g. what it does, its value, origin, history): |
| 19 | + * ??? |
| 20 | +1. URL to list of project adopters (e.g. ADOPTERS.md or logos on the project |
| 21 | + website. For a spec have a list of adopters for the implementation(s) of the |
| 22 | + spec): |
| 23 | + * ??? |
| 24 | +1. License type (should be Apache 2): ??? |
| 25 | +1. URL to license: |
| 26 | + * ??? |
| 27 | +1. TOC sponsor name (if one exists): ??? |
| 28 | +1. URL to Core Infrastructure Initiative |
| 29 | + [Best Practices Badge](https://bestpractices.coreinfrastructure.org/): |
| 30 | + * ??? |
| 31 | +1. URLs to independent and 3rd party security audit results: |
| 32 | + * ??? |
| 33 | +1. URLs to governance documentation: |
| 34 | + * ??? |
| 35 | +1. Names of organizations that have current/active maintainers with the |
| 36 | + maintainer GitHub IDs (should have at least 2 orgs): |
| 37 | + * ???org (@???githubID, ...) |
| 38 | +1. URLs to previous CNCF applications (e.g. sandbox, incubator): |
| 39 | + * sandbox: ??? |
| 40 | + * incubator: ??? |
9 | 41 |
|
10 |
| -### * Have achieved and maintained a [Core Infrastructure Initiative Best Practices Badge](https://bestpractices.coreinfrastructure.org/). |
11 | 42 |
|
12 |
| -### * Have completed an independent and third party security audit with results published of similar scope and quality as [this example](https://github.com/envoyproxy/envoy#security-audit) which includes all critical vulnerabilities and all critical vulnerabilities need to be addressed before graduation. |
| 43 | +## Graduation Information |
13 | 44 |
|
14 |
| -### * Explicitly define a project governance and committer process. The committer process should cover the full committer lifecycle including onboarding and offboarding or emeritus criteria. This preferably is laid out in a GOVERNANCE.md file and references an OWNERS.md file showing the current and emeritus committers. |
| 45 | +1. Why is this project ready to graduate? |
| 46 | + * ??? |
15 | 47 |
|
16 |
| -### * Explicitly define the criteria, process and offboarding or emeritus conditions for project maintainers; or those who may interact with the CNCF on behalf of the project. The list of maintainers should be preferably be stored in a MAINTAINERS.md file and audited at a minimum of an annual cadence. |
| 48 | +1. What has changed since the project was approved for incubation? |
| 49 | + * ??? |
17 | 50 |
|
18 |
| -### * Have a public list of Project adopters for at least the primary repo (e.g., ADOPTERS.md or logos on the Project website). For a specification, have a list of adopters for the implementation(s) of the spec. Refer to [FAQs](https://github.com/cncf/toc/blob/main/FAQ.md#what-is-the-definition-of-an-adopter) for guidelines on identifying adopters. |
| 51 | +1. How can the project survive its founders and founding companies? |
| 52 | + * ??? |
19 | 53 |
|
20 |
| -## Incubation Details |
21 |
| -_**Project should address each area listed below**_ |
| 54 | +1. Project adopters: |
| 55 | + * Typical adopters (e.g. cloud providers, end users): |
| 56 | + * ??? |
| 57 | + * Provide a list of adopters who are willing to chat with the TOC about |
| 58 | + their experiences with the project and its community (about 2-4. Questions |
| 59 | + might include: how/why do you use it? its stengths and weaknesses? |
| 60 | + are community interactions positive/responsive/timely?): |
| 61 | + * ???name (???id at ???domainName) |
| 62 | + * Adopter quotes with attribution: |
| 63 | + * ???name : ???quote |
| 64 | + |
| 65 | + |
| 66 | +## Due Diligence |
| 67 | + |
| 68 | +### Project Details |
| 69 | + |
| 70 | +1. What is the origin and history of the project? |
| 71 | + * ??? |
| 72 | + |
| 73 | +1. Describe how the project is useful to the cloud native community and how it |
| 74 | + complements other cloud native (CNCF) projects: |
| 75 | + * ??? |
| 76 | + |
| 77 | +1. Scope of the project: |
| 78 | + * primary in-scope use cases supported today: |
| 79 | + * ??? |
| 80 | + * planned use cases (in the roadmap): |
| 81 | + * ??? |
| 82 | + * out-of-scope use cases: |
| 83 | + * ??? |
| 84 | + |
| 85 | +### Governance and Processes |
| 86 | + |
| 87 | +1. Link to the project's Code of Conduct that adheres to the CNCF guidelines: |
| 88 | + * ??? |
| 89 | + |
| 90 | +1. Describe the governance (decision making) process of the project (a link to |
| 91 | + the governance doc was provided above, so this is an opportunity to explain |
| 92 | + (in plain English) how the project is self-governed and community driven): |
| 93 | + * ??? |
| 94 | + |
| 95 | +1. Describe how the project is aligned with the |
| 96 | + [CNCF principles](https://github.com/cncf/toc/blob/main/PRINCIPLES.md): |
| 97 | + * ??? |
| 98 | + |
| 99 | +1. URLs to maintainer and emeritus processes (The processes should cover the |
| 100 | + full maintainer lifecycle including onboarding, offboarding and emeritus |
| 101 | + criteria. This preferably is laid out in a GOVERNANCE.md file and references |
| 102 | + an OWNERS.md file showing the current and emeritus maintainers): |
| 103 | + * ??? |
| 104 | + |
| 105 | +1. Change and issue processes: |
| 106 | + * URL to issues: |
| 107 | + * ??? |
| 108 | + * URL to PRs/change requests: |
| 109 | + * ??? |
| 110 | + * Does the project use a CLA, DCO or something else? |
| 111 | + * ??? |
| 112 | + * How are security issues reported? |
| 113 | + * ??? |
| 114 | + |
| 115 | +1. Is there any external funding for the project beyond what the CNF provides? |
| 116 | + * ??? |
| 117 | + |
| 118 | +### Health and Adoption |
| 119 | + |
| 120 | +1. Provide evidence of production deployments that are of high-quality and |
| 121 | + high velocity (e.g. list of independent adopters who are using it in |
| 122 | + production): |
| 123 | + * ??? |
| 124 | + |
| 125 | +1. URLs to commit stats of the project (something that shows the rate of change |
| 126 | + in the project, and by which organization, over time, issue/PR velocity |
| 127 | + tracking stats): |
| 128 | + * ??? |
| 129 | + |
| 130 | +1. Information about the project's community size and/or sponsorships |
| 131 | + (details to help the TOC guage the popularity and adoption rate of the |
| 132 | + project within the cloud native community): |
| 133 | + ??? |
| 134 | + |
| 135 | +1. Compare and contrast with peers in this space (e.g. textual, summary matrix, |
| 136 | + strengths/weaknesses, when would a peer be a better fit for an adopter): |
| 137 | + * ??? |
| 138 | + |
| 139 | +### Community |
| 140 | + |
| 141 | +1. Describe the communication mechanisms used within the project team members |
| 142 | + and with the broader community (e.g. email, slack, blogs): |
| 143 | + * ??? |
| 144 | + |
| 145 | +1. What is the time commitment to the project? (e.g. how many are full-time vs |
| 146 | + part-time? hours per week for maintainers): |
| 147 | + * ??? |
| 148 | + |
| 149 | +1. How are roles within the project defined and assigned? (e.g. release lead, |
| 150 | + architect, wg lead): |
| 151 | + * ??? |
| 152 | + |
| 153 | +### Development and Technical Details |
| 154 | + |
| 155 | +1. URL to the release methodology and mechanics (versioning model - e.g. |
| 156 | + semver): |
| 157 | + * ??? |
| 158 | + |
| 159 | +1. URLs to architectural high-level designs and feature overviews of the |
| 160 | + project: |
| 161 | + * ??? |
| 162 | + |
| 163 | +1. Provide any information related to the performance, scalability and resource |
| 164 | + consumption of the project (e.g. URLs to testing results. Trade-offs made |
| 165 | + regarding, performance, scalability, complexity, reliability, security, etc. |
| 166 | + Are they implicit or explicit? Why? Are they user-tunable?): |
| 167 | + * ??? |
| 168 | + |
| 169 | +1. Provide any information about known gaps (e.g. no HA, no flow control, |
| 170 | + integration issues): |
| 171 | + * ??? |
| 172 | + |
| 173 | +1. URLs on how code reviews are done: |
| 174 | + * ??? |
| 175 | + |
| 176 | +1. Provide information about the CI/CD process and status (how do you test? |
| 177 | + measure code coverage? test for vulnerabilities? Types of testing: unit, |
| 178 | + integration, interface, end-to-end): |
| 179 | + * ??? |
| 180 | + |
| 181 | +1. List any external dependencies (including licenses): |
| 182 | + * ??? |
| 183 | + |
| 184 | +1. Are there any licensing issues to be aware of? |
| 185 | + * ??? |
| 186 | + |
| 187 | +1. What are the recommended operational models? E.g. how is it operated in a |
| 188 | + cloud native environment, such as Kubernetes: |
| 189 | + * ??? |
| 190 | + |
| 191 | +1. Provide links and information about the project's documentation? Is it |
| 192 | + translated into non-English languages? |
| 193 | + * ??? |
22 | 194 |
|
23 |
| -### * Link to Incubation Due Diligence(DD) Document |
24 | 195 |
|
25 |
| -### * Address any concerns or recommendations from the TAG and/or TOC sponsor(s) from the DD Document |
|
0 commit comments