Date: Fri, 29 Mar 2024 06:32:56 +0000 (UTC)
Message-ID: <713774625.35463.1711693976871@aws-us-west-2-lfedge-confluence-1.web.codeaurora.org>
Subject: Exported From Confluence
MIME-Version: 1.0
Content-Type: multipart/related;
boundary="----=_Part_35462_3834404.1711693976871"
------=_Part_35462_3834404.1711693976871
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Content-Location: file:///C:/exported.html
(Project input always welco=
me to add to/enhance the list below)
Welcome to LF Edge! Below is a checklist to help you get started as a ne=
w technical project.
Please bookmark this page and "watch" (top right of page to enable watch=
ing) the page for updates. For any questions, please email info@lfedg=
e.org to connect with LF Edge staff.
Please copy and paste this checklist onto your project wiki to t=
rack your progress - Please include links to your finished work.=
p>
If you are not familiar with Confluence/Wiki or need a refresher, visit =
the Confluence Overview.
- Upon LF Edge TAC Project acceptance, a serie=
s of asset transfers will be set in motion. Standard transfer list includes=
:
- Trademark=
(Unless we are coming up with a new name for the Project or the Project is=
newly created, all Project names need to be transferred to LF Projects, LL=
C to be held for the benefit of the community (done using a Project Contrib=
ution Agreement). This is required even if no trademark registrations =
have been secured in the Project's name.)
- Website Domain (if Project has an existing =
site)
- Social Media Handles (if any)
- GitHub (LF enforces 2FA on all of our organ=
izations. Please also inform all=
developers to enable 2FA on their Github accounts, if they haven't already=
.)
- Project Integration into LF Edge Overview D=
eck(s)
- Work with LF Edge staff to add Project to m=
ain Overview Deck, Getting Started Guide (pointed to under Resources tab of=
https://www.lfedge.org/ as well as presented at Conference=
s/Events/etc)
- Project Logo
- Transfer existing or work with LF Creative =
Services team to build out/finalize a new logo. Other LF Edge Project logos=
can be seen at https://www.lfedge.org/projects/
- Review and Bookmark the LF Edge Wiki Homepa=
ge
- Familiarize yourself with the key resources =
for LF Edge<=
/li>
- Pr=
oject Mail Lists
- Sub=
scribe to the project specific mail lists via the LF Edge Groups.io - Subscribe to any other mail li=
sts your are interested in
- Pr=
ojects should establish, through the LF Edge staff, an initial set of mail =
lists (examples: project@, project-tsc@, project-devel@)
- The Project Lead(s) should be set as moderat=
or for ongoing management of the project specific mail lists - LF Edge staf=
f can assist with moderator permissions
- Pro=
ject Meeting Calendars
- Wo=
rk with LF Staff to provision Zoom meeting Host access for your Project mee=
tings
- On=
ce meeting(s) have been scheduled in Zoom, add them to the Groups.io mail l=
ist calendar - Example, Example=
- Co=
mmunity members can Subscribe to all meeting invites for mail lists which t=
hey belong to at https://lists.lfedge.org/calendar&n=
bsp;(note: if you are not subscribed to any mail lists, this would appear e=
mpty)
- Fo=
r legacy Projects which have their own Groups.io instances, community membe=
rs will need to subscribe to their meeting invites separately (Akraino Edge Stack, EdgeX Foundry)
- Cu=
rrent advisory notice: Known integration issue between Groups.io calendars =
and some mail clients (due to time zone change). Recommended solution is to=
schedule meetings on Groups.io calendars using UTC zone. This will populat=
e calendar entries correctly across all mail clients (Outlook, Gmail, etc.)=
- A =
Community Meetings & Calendar page can be created on your Wiki with det=
ailed instructions - Exampl=
e
- Pr=
oject Slack
- Es=
tablish Project channels on the LF Edge Slack (examples: #project, #project=
-help, #project-tsc) - Note Slack's message archiving limits; encourage usa=
ge primarily for short-term discussion (not something you may want to refer=
ence later). Mail lists will be best in most instances.
- Pr=
oject Wiki
- Exp=
and upon the wiki created for the project - The wiki will be publicly avail=
able
- Exa=
mple wiki pages include: Homepage, Introduction/Overview, TSC, Calendar, Documentation, =
Releases, Community Governance, etc.
- Gi=
tHub Recommended Practices for LF Edge Projects
- Rev=
iew and implement the GitHub Recommended Practices for LF Edge Projects (Links to LF AI =E2=80=93 For LF Edge=
TAC Consideration on whether to adopt a similar set of recommendations)
- Do=
cument the process by which contributors can become maintainers (and eventu=
ally be retired) - example
- Ha=
ve a MAINTAINERS.md (or rst) file in each repo documenting who the main=
tainers are - example=
- Ad=
opt a common repository structure for all of its projects, leveraging the T=
ODO repolinter tool to enforce it - example
- LF =
Edge PPT/Google Slides Template
- Pl=
ease email LF PM for PowerPoint/Google Slides template, for use in TSC meet=
ings, etc..
- Pr=
oject Technical Charter
- Rev=
iew the project technical charter (draft will be sent by the LF) to determi=
ne the various actions required (common examples noted below) - The project=
's technical charter will be linked to the project wiki home page (Technica=
l Charters for all LF Edge Projects can also be found at https://wiki.lfedge.org/)
- Doc=
ument Mission and Scope of the Project
- Ens=
ure the project's README file within the code repository in GitHub lists th=
e project's mission
- Ensure the project is using an OSI-approved =
open source license
- Kick off the Technical Steering Committee (T=
SC) for technical oversight of the project
- Establish the TSC voting members according t=
o the project technical charter - TSC voting members must be listed on the =
project wiki - =
Example
- Build out a community governance wiki page&n=
bsp;with the projects details - Example 1, Example 2 (Best Prac=
tice for Stage 3 Projects)
- Establish a recurring (minimum monthly sugge=
sted) TSC meeting which should be open to the public; electronically, telec=
onference, or in person - LF Edge staff can help schedule the first me=
eting
- TSC meeting information should be included o=
n the project's wiki - Example
- Set a meeting process which must include:
- Meeting minutes (attendance, quorum check, k=
ey discussion items, actions) posted to the project wiki and emailed to the=
project mail list - Example=
(LF Edge Staff can help set up your Confluence for Meeting Minute tracking=
)
- Meetings should be recorded and posted to th=
e project wiki with the link included in the email sent to the project mail=
list
- Identify =
the project roles (contributors, committers, etc.) according to the project=
technical charter and document them on the project wiki - Example
- Establish and document on the project wiki t=
he work flow procedures for (1) the submission, approval, and closure/archi=
ving of projects, (2) set requirements for the promotion of Contributors to=
Committer status, as applicable, and (3) amend, adjust, refine and/or elim=
inate the roles of Contributors, and Committers, and create new roles, and =
publicly document any TSC roles, as it sees fit - Example, Example
- Elect a TSC Chairperson - =
Example
- Ensure all TSC members are familiarized with=
the roles and responsibilities listed in the project technical charter -&n=
bsp;The project's technical charte=
r will be linked to the project wiki home page
- TSC Voting
- Understand the voting requirements (eligibil=
ity, quorum, etc.) and procedures as noted in the project technical charter=
- Voting details should be noted on the project wiki - <=
a href=3D"https://wiki.akraino.org/display/AK/Akraino+Technical+Community+D=
ocument#AkrainoTechnicalCommunityDocument-4.4.2.2TSCChairandCo-Chairfunctio=
nalroles" class=3D"external-link" rel=3D"nofollow">Example
- Compliance with Policies
- Adopt a code conduct (subject to LF Edge app=
roval) or utilize the LF Projects Code of Conduct listed at =
;https://lfprojects.org/=
policies/ - Document the Code of Conduct on the project wiki
- Understand and adhere to the Series Agreemen=
t for the Project and the Operating Agreement of LF Projects listed at https://lfproject=
s.org/policies/ and as noted in the project technical charter
- Adhere to the processes required for any pol=
icy changes according to the project technical charter - Any changes must b=
e documented on the project wiki
- Allow open participation from any indiv=
idual or organization meeting the requirements for contributing under the p=
roject technical charter and any policies adopted for all participants by t=
he TSC, regardless of competitive interests - For any concerns, reach =
out to LF Edge staff
- Operate in a transparent, open, collaborativ=
e, and ethical manner at all times - The output of all project discuss=
ions, proposals, timelines, decisions, and status should be made
open and easily visible to all - For any concerns, reach out to LF Edge sta=
ff
- Community Assets - Understand and adhere to =
the guidelines set in the project technical charter
- General Rules & Operations - Unders=
tand and adhere to the guidelines set in the project technical charter
- Intellectual Property Policy - Understa=
nd and adhere to the guidelines set in the project technical charter
- Amendments - Understand and adhere to t=
he guidelines set in the project technical charter
- Getting LF IT Help (Projects) - General=
problems and support requests: If you need help with anything IT-rela=
ted for your LF IT project, please use our Service Desk platform to open a =
support request: support.linuxfoundation.org (<=
a href=3D"/download/attachments/24530968/Getting%20LF%20IT%20Help.pdf?versi=
on=3D1&modificationDate=3D1588965616828&api=3Dv2" data-linked-resou=
rce-id=3D"26611407" data-linked-resource-version=3D"1" data-linked-resource=
-type=3D"attachment" data-linked-resource-default-alias=3D"Getting LF IT He=
lp.pdf" data-nice-type=3D"PDF Document" data-linked-resource-content-type=
=3D"application/pdf" data-linked-resource-container-id=3D"24530968" data-li=
nked-resource-container-version=3D"28">more information)
- TAC Sponsor Engagement
- We encourage you to connect with your =
TAC sponsors and leverage the wealth of knowledge that they can provide
- CII Best Practices Badge Program (Best =
Practice for Stage 3 Projects)
------=_Part_35462_3834404.1711693976871--