Community Q&A

Community Q&A

These are step-by-step guides to help you through some of our most common questions.  Want to contribute to the Q&A?  Contact @Casey Cain at support@lfnetworking.org or ccain@linuxfoundation.org.

Please make sure you read our Getting Started guide first!

 

Individual Contributor Onboarding

I want to contribute to Sub Project X

Welcome!  We are excited to have new contributors to the Nephio Community. 

First, you should check out our Project Getting Started Guide.  It has some great tips for:

  • Getting your Linux Foundation Identity profile setup at https://openprofile.dev

  • Joining our mailing lists

    • Don't be afraid to ask questions!

  • Participating in Community Meetings

    • All community meetings are open to the public (with the exception of the Governing Board).

    • Feel free to lurk and learn or contribute to the conversation.

  • We recommend small, iterative contributions.  Large imports of code are not generally received favorably.

  • If you are looking to contribute to a specific component

    • Check the Working Group or SIG page here on the wiki to see who the PTL (Primary Contact) is. This information should be available in the side panel of each group.

    • Look at the LFX Project Insights to see who is contributing.  This can be super helpful in identifying who the active participants are.

I get an error when I attempt to contribute code.

EasyCLA has been enabled for the Community.  If you are getting an error when you attempt to contribute, please make sure you use -s when you commit.

This Project has elected to adopt Contributor License Agreements. Instructions for EasyCLA depend on a number of factors.

  • More information about EasyCLA can be found here:

  • Are you contributing as an employee of a Member Organization? 

    • All contributors will need to sign your CCLA (Corporate Contributor License Agreement) agreement.

    • If your Organization has not yet appointed a CCLA Manager, please coordinate with your organization's Signing Authority.

  • Are you unaffiliated with an Organization and contributing as an Individual?

    • This is usually students or job seekers contributing to pad their open-source credentials.

    • You need to complete your ICLA (Individual Contributor License Agreement.

I want to contribute to a repository, but I can’t get in touch with the Committers / Maintainers.

If you are a contributor and for some reason you are having trouble getting your code merged, please reach out to the appropriate SIG or Working Group Mailing List first to see if you can reach the maintainers of the repository. If you are unable to reach the maintainers of a repository, first, please reach out to support@lfnetworking.org to request assistance from the Linux Foundation community support team.

The process for becoming a Committer (someone who can merge code to a repository) is outlined in the Nephio Technical Community Document .

  • For moribund repositories, please escalate to the TSC as defined in section 3.2.2.2 of the charter.

    • When the TSC has voted to approve a new Committer(Maintainer), they can open a ticket at support@lfnetworking.org with the following information:

      • Name

      • GitHub id

      • Vote from the TSC approving the committer promotion

I want to participate in the mailing list conversations.  What lists should I join and why?

Mailing lists are our primary means of communication.

  • Main - The Nephio Community uses Groups.io as its mailing list platform.  In order to join any of the other lists, you must be a member of "Main."  Don't worry; this list will rarely see any traffic.

  • TSC - This mailing list is used by the Technical Steering Committee to discuss and announce governance and technical changes that could affect all community members.  It is recommended that you monitor this list.

Each Sub Project and Working Group also has its own mailing list!  You can view the complete list here: Mailing Lists

I saw the Community meetings. Can I participate?  How?

Yes! Community meetings are open to the public.  Please feel free to join our discussions.

  • Make sure you've set up your Linux Foundation Identity

  • Check the Nephio Wiki SIG or Working Group page to find the link for "Meeting Registration / Join."

  • You can also check out our Community Calendar which has a listing for all public meetings and a link to recordings for past meetings.

    • Following this link will allow you to register for the meeting, which will send a meeting invite to your preferred email set in your Linux Foundation Profile.

I am a contributing member of the Community, and I want to become a voting member of the TSC.

The process to join the TSC is laid out in the Nephio Technical Charter Section 4.

I want to propose a new Sub Project.

Want to propose a new Nephio Project?

  • First, check to make sure that you meet the Nephio Project Intellectual Property Policy.

  • Next, make sure you are aware of the Contributing Guidelines.

  • While not required, you can also reference the Upstream First Best Practices Guide for some contribution best practices.

  • Finally, you should inform the TSC via email of your desire to propose a new project.

    • Not all of these are requirements; however, the more detail you can provide when submitting your proposal, the better.  

      • Project vitals

        • Name

        • Creation Date

        • Does it conform to the Intellectual Property Policy?

        • Contributing Organizations

        • Seed code availability

        • Proposed timeline of the project release schedule.

      • Use Case / Problem Statement.

        • Problem Statement: This is where you define the problem that your project is designed to solve. Be specific about what the problem is, who it affects, and what implications it has. The problem statement should be succinct, focused, and clear.

        • Use Case Scenarios: List and describe typical situations where your project would be applied. Who are the users? What are their goals? What tasks are they performing, and how does your project assist in accomplishing these tasks? Be sure to highlight how your project is unique in addressing these needs.

      • Project Architecture

        • Your aim here is to give the TSC a clear understanding of how your project is structured and how its various components interact.

        • High-Level Overview: Provide a general description of your project's architecture. This can include the guiding principles behind its design, the architectural style or pattern it follows (e.g., microservices, event-driven, layered), and any notable characteristics.

        • Component Diagram: Include a diagram illustrating the main components of your project and their interactions. This visual representation can greatly enhance understanding. Be sure to label all parts of the diagram and provide a brief description of each component's function.

        • Key Interfaces & Dependencies: Describe the critical interfaces within your project and any external dependencies.

        • Data Flow: If applicable, briefly explain how data flows within your system. This can be included in your component diagram or described separately.

        • Future Evolution: Briefly outline any planned or potential changes to your project's architecture.

Can I create a new Repository for ...

We encourage you first to begin participating in the upstream discussion channels. Once you're ready, please follow the guidance for proposing a new sub-project.

I'm having trouble with ... Confluence, Single-Sign-On, EasyCLA, Community Analytics(Insights), etc

Sometimes, we all need a little help, but where do I go, and who do I ask?

  • LF Toolchain Support

  • LFX Community Forums

  • Community Support

    • For help getting started with contributing to the community

      • Reach out to SIG or Working Group via the mailing list or directly to the Chairperson. Information will be available on the wiki page associated with the group.

    • For any support not related to LF Infrastructure, such as registering for or updating Community Meetings, please reach out to the Linux Foundation Program Management team at support@lfnetworking.org or @Casey Cain at ccain@linuxfoundation.org.

I'm having trouble joining a Community Meeting

Here are some common troubleshooting steps:

  • First, have you registered for the meeting?

    • Check https://openprofile.dev/my-calendar to see if the meeting is listed in your Upcoming Meetings tab.

    • If you are registered, you can also come here to send yourself a new meeting invite!

  • Check your Individual Dashboard to make sure that the email address you expect to use for Meeting Invites is set correctly.

  • Still having trouble?  Open a ticket by emailing support@lfnetworking.org

    • The Linux Foundation Operations team (@Casey Cain ) has limited ability to solve technical issues, but if you are experiencing issues, you can also ping them on Slack.

I am a member of a Committee, but I can't attend the next Meeting. Do I need to do anything?

Please notify the committee via email that you will not be present. 

If you have not yet, you should appoint an alternative.  This person is someone that you trust to faithfully communicate your vote.  Committee members can appoint a standing proxy, but the primary should still notify their committee of their absence. Proxies will not be accepted without an email from the Committee member appointing them as a standing proxy or as a one-time appointment.

When I look at Insights, my contribution metrics are wrong? How can we fix this?

LFX Insights is an open-source project analytics tool that empowers you with valuable data-driven insights. LFX Insights is only as accurate as our members make it.

 


Organization Onboarding

Our Organization is new to open source and wants to start contributing to the Nephio Project.

Welcome!  We are excited to have new contributors to the Nephio Community. 

First, you should check out our Project Getting Started Guide.  It has some great tips for:

  • Getting your Linux Foundation Identity profile setup at https://openprofile.dev

  • Joining our mailing lists

    • Don't be afraid to ask questions!

  • Participating in Community Meetings

    • All community meetings are open to the public (with the exception of the Governing Board).

    • Feel free to lurk and learn or contribute to the conversation.

Still not sure how to get started? 

My Organization wants to join LF Networking as a Member.  What should we do?

That's a great question! Here are the steps to become a Member.

  • Membership has a host of benefits! To get started, join using our automated Member Enrollment

    • https://enrollment.lfx.linuxfoundation.org/?project=lfn

      • You will be asked to provide your organisation's logo in .svg format

      • You will be asked to identify your Key Contacts (Legal, Voting, Marketing, etc)

      • You will be asked to identify your Billing Details for Membership

      • Invoices are typically issued within one week

    • Selection of Membership Tier (Premier, General, or Associate) 

  • Once the Membership record is created and processed

    • Project Notification Group is emailed automatically

    • The logo, if provided, will be automatically added to the web page with our Landscape tool the day the membership becomes active (Refer to Terms of Agreement)

  • Membership details, Key Contacts, legal information, and more can be found on the MyOrg Dashboard once your membership has been processed.

Our Organization recently joined LF Networking as a Member.  Where can I track my benefits and Project Engagement, Key Contacts, Legal Agreements (Including EasyCLA), Training and Certification credits, Employee contributions, Event engagements, and Access to LF Research?

You're looking for the MyOrg Dashboard!

My Organization has been participating in the Nephio Community. Can we participate in the Governing Board?

Information about the Governing Board can be found in the LFN Agreement & Funding Charter

The Governing Board voting members will consist of: 

  • The Directed Fund will be composed of Platinum Members, Gold Members, Silver Members and Associate Members (collectively, “Members”). All Members must be current members of the LF (at any level) in good standing to participate in the Directed Fund as a member. All participants in the Directed Fund, enjoy the privileges and undertake the obligations described in this Charter, as from time to time amended by the Governing Board with the approval of the LF. During the term of their membership, all members will comply with all such policies as the LF Board of Directors and/or the Directed Fund may adopt with notice to members.

  • There will be a maximum of 26 Platinum Members (the “Platinum Cap”), which can be raised by vote of the Governing Board.

To join LF Networking as a Member, please follow the guidance here on the Member Enrollment forum.

My Organization wants to understand who is contributing to Nephio / Sub Project X 

The Linux Foundation provides an open-source project analytics tool that empowers you with valuable data-driven insights.

  • Check our LFX Insights 

    • Track the performance of open source projects in real time.

    • Want to analyze data quickly?

    • Are looking for an online reporting tool.

    • Want to download the reports in CSV or any other format?

    • Compare the reports for the selected time period.

    • Measure the project's growth and the team's performance.

    • Track historical data to identify trends and patterns.

    • Detect potential issues early and take corrective actions.

My Organization is an active participant in the development of the project, but we are not a Member.  Can we still have our logo displayed?

This information is in draft review.  Please come back soon for more details.