DRAFT- LFN Sandbox Project Data Template
Placeholder page to create candidate project checklist, documentation and TAC presentation slide template.
Instructions
This page is intended to give provide detailed information on how to prepare and present a new project as an LFN Sandbox project. A Sandbox project is described as The Sandbox stage is designed to provide a lightweight entry process for new projects that align with the LFN mission and follow the guidelines described below. It is ideal for early-stage projects that require time to explore their community, governance, and technical roadmap. Note, this template and checklist may be used for promotion from Candidate project to Sandbox project, or as a new project induction as a Sandbox project.
Use the checklist below to prepare and present the project presentation, also below, to the LFN TAC for induction as an LFN Candidate project.
Other useful links are at the bottom of the page.
Need Help? Contact: support@lfnetworking.org
TAC Presentation Template
How to fill out the above presentation
Project Name: Please fill in the official name of the project. This is the name that will be used in all official documentation and communication.
Project Description: Provide a short description of what the project is about.
Project Mission: Describe what the project is trying to achieve
Technical Charter: Please provide a link to the technical charter for your project, and also note the date it was established. The technical charter outlines the mission, scope, and operations of the project.
Project License: Specify the license under which your project is distributed. Examples include Apache 2.0, MIT, GPL, etc. If you have multiple licenses, please list them all.
Source Code Repos and Seed Code Availability: Enter the date when the seed code, or initial codebase, of your project will be or was made available. Also, list the repositories where this code can be found.
Website: <link to project landing page>
Wiki: <link to wiki>
Mailing list: <LFN project mailing list>
Zulip or Slack channels (optional)
Community Meetings (if already scheduled): Recommended to have a kick-off meeting scheduled at time of presentation to allow interested parties to join and plan for regular community meeting cadence
Initial Project Contacts / Technical Steering Committee: Provide relevant project community contacts (maintainers, TSC contacts), LFN Project Manager, Stakeholders
Positioning Statement alongside LFN projects: Explain why is the project the right fit for LFN and where you could see potential collaboration with other LFN projects.
Checklist
Category | Task | Who? | Requires input from | Mandatory | Comments | Status |
|---|---|---|---|---|---|---|
LFX | PCC Onboarding | LF PM | Community (project name, project description and mission statement, charter) | Y | LF PM May not have the right access rights for LF level projects | |
LF ID for project members | Community |
|
|
| ||
Infrastructure | Source Control (Github, Gitlab) | LF PM | Community | Y |
| |
Wiki | LF PM |
| Y | If project is unfunded and not under LFN, This is not possible | ||
Mailing list | LF PM |
| Y |
| ||
Slack/Zulip | LF PM |
| N |
| ||
Marketing | Domain and Landing page | LF PM | Community | Y |
| |
Press Release | LF Marketing | Community | N |
| ||
Creating a Pitch deck | LF Staff | Community | Y | Based on the project presentation template filled by the community | ||
Completion of project presentation template (for TAC) | Community | LF PM | Y |
| ||
Charter creation | LF Staff, Community | LF PM | Y |
| ||
Charter linking in Git | LF PM |
| Y |
| ||
License reference (or actual license text if unique) | LF PM | Community | Y |
| ||
TSC Contacts | Community |
| Y |
| ||
Create a Contributing.md and Governance.md files in the repo | Community | LF PM | Y |
| ||
TSC contacts listing in Wiki and governance.md | LF PM |
|
|
| ||
Setting up community meetings and documenting in Wiki/Git | LF PM | Community | N |
|
Coding | Sandbox |
|
|---|---|---|
Code Scanning | An intake scan is conducted to ensure basic security and license compliance. | |
Seed code handoff | A date for seed code handoff is planned and communicated to stakeholders. | |
Coding Standards | Coding standards are loosely defined, allowing for flexibility and creativity in the early stages of the project. | |
Development Governance | Sandbox |
|
Adding/Removing Committers | Mandatory - Projects must have a documented process for adding and removing committers. | |
Adding/Removing PTLs (Project Team Leads) | Not required at this early stage, roles might be more informal and fluid. | |
Sub-Project Lifecycle | Not required at this early stage, the focus is on the core project. | |
Sub-Projects Without a Designated Lead | Allowed - At this stage, sub-projects might not yet be formalized | |
Dispute Resolution | Not mandatory, but it's beneficial to have some basic dispute resolution mechanism. | |
TSC/TOC Governance | Appointments OK - At this early stage, key roles can be appointed to steer the project. | |
Documentation | Sandbox |
|
Technical Documentation | Build - Initial creation of technical documentation to guide early adopters and contributors. | |
Contributor onboarding Documentation | Not required at this early stage. | |
Company Diversity (past 12 months) | variable | |
# of Contributors | Few - At this early stage, the focus is on setting up the project and attracting initial contributors. | |
Release Management | RM consultation with LFN (minimum) - At this stage, the release management process is being set up with guidance from LFN. | |
CI/CD | Manual - At this stage, the project might rely more on manual methods for integration and deployment. | |
Adoption | Not a focus at this stage. | |
Security design principals | Not a focus at this early stage. |