Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

LFN Sandbox Induction Review:


View file
nameCNTi LFN Data TemplateSandbox Induction.pptxpageLFN Project Data Template
height250



These tips can assist you in completing each slide:

Project Vitals



This slide is an overview of the fundamental information about your project.

  • 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 Creation Date: Enter the date when the project was officially started or initiated.

  • 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.

  • Contributing Organizations: Here, you should list all organizations that are actively contributing to the project. This includes companies, academic institutions, non-profits, etc.

  • 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.
  • Release Schedule: This is where you detail the timeline of your project's release. It might include dates for the start of development, feature freeze, code freeze, testing periods, and the final release date. If you have a consistent release cycle (e.g., every 6 months), you can specify that here.

Project & Community Resources

This slide provides information about the resources that your project has in place to foster communication, collaboration, and transparency in your community.

  • 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.
  • TSC Established: Note the date when the Technical Steering Committee (TSC) was established for the project. The TSC typically oversees the technical direction of the project.
  • Website: Provide a link to the project's official website, if it exists. This is where newcomers can find general information about the project.
  • Wiki: If there is a project Wiki, provide the link here. This can be a valuable resource for detailed technical information, community guidelines, and more.
  • Mailing list: Include a link to the project's mailing list, which is a key communication channel for many open source projects.
  • Community size (based on mailing list): Indicate the size of your project's community. A simple way to estimate this is by looking at the number of subscribers to your project's mailing list.
  • Community Meetings: Provide information about any regular meetings held by your community. This can include the meeting schedule, agenda, and how to participate (e.g., a Zoom link, IRC channel, etc.).

Project Governance

This slide offers information about how your project is organized and managed, and how decisions are made.

...

Remember, this slide should provide a clear overview of how your project's governance operates. The clearer this is, the easier it will be for newcomers to understand how they can participate and contribute to the project.

Use Case / Problem Statement

This slide is your opportunity to clearly define the specific problem your project aims to solve, as well as the use case scenarios your project addresses. This will help the TAC understand the context and importance of your project. Here are some pointers to guide you through the process:

...

Remember, clarity is key. Provide enough detail to comprehensively view the problem and use case scenarios, but strive to keep your language simple and direct.

Project Architecture

This slide is dedicated to presenting your project's architecture. Your aim here is to give the TAC a clear understanding of how your project is structured and how its various components interact. Below are some guidelines to assist you:

...

Remember, your goal here is to provide a clear, concise overview that's understandable even to those who may not be familiar with every technical detail.

Infrastructure Tooling


In this slide, you are expected to present an overview of the tools your project utilizes for its infrastructure. These are crucial to your project's operation, allowing your team to collaborate effectively, track progress, handle issues, and maintain high-quality standards.

...

Remember, it's not just about listing the tools—you should provide direct links and briefly explain how each tool contributes to your project's infrastructure and workflow.

Roadmap

In this final slide, you are to provide an overview of your project's future trajectory. The roadmap should highlight the key milestones and deliverables your project aims to achieve in the upcoming quarters or years. Here's a guide to help you fill it out:

...