Project Definition
Last updated
Last updated
Copyright © 2022 The Linux Foundation®. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks.
Project Definition for a project allows you to view and edit information related:
Project Details
Legal Details
Branding and Media
Project Staff
Artifacts
To access the Project Definition, perform the following steps:
Log in to PCC.
The Project dashboard appears. Click Project Definition from the Operations tab.
You can update basic information related to the project such as common name, stage of the project, and slug name.
To update basic information for a project, perform the following steps:
Click on the required project and click Project Definition.
Click Edit from the Project Details section to update basic information.
The Edit Basic dialog box appears. Update the following details, and click Save.
Field | Action |
Common Name | This field refers to the name by which the project is commonly known. Enter a recognizable name that accurately represents the project. |
Category | Select a category from the dropdown that best describes the nature of the project. |
Slug | The slug is a user-friendly and URL-valid version of the project name. It is typically used in the project's URL and should be unique, descriptive, and easy to remember. |
Stage | Select the appropriate stage of the project. By default, the stage is selected to Prospect when you create a new project. |
Announcement Date | Select the date The date when the project was officially announced or launched. |
Repository URL | The web address (URL) of the project's code repository, is typically hosted on a platform like GitHub. |
Technology Sector | Select an appropriate technology sector for your project. You can also select more than one sector. If you feel that your project falls across all sectors, check the Cross Technology box. |
Industry Sector | Select an appropriate industry sector for your project. You can also select more than one sector. If you feel that your project falls across all sectors, check the Cross-Industry box. |
Technical Activity Type | Select your project's technical activities from the dropdown, such as Open source software, Open Hardware, Open Data, Community Initiative, etc. |
Funding | Select funding type for your project. If you select the funding type as Funded, then the Model field becomes mandatory. |
Model | Select an appropriate model for your project. This field becomes mandatory when the funding type of your project is Funded. |
OpenSSF Best Practice Badge ID | If applicable, the ID of the Open Source Security Foundation (OpenSSF) Best Practices Badge awarded to the project. Earlier referred to as CII Project ID. |
Description | Provide the project's summary outlining its objectives, features, and key functionalities. This description helps in communicating the project's purpose and scope to stakeholders. |
Mission Statment | Write a concise statement that defines the project's core purpose and values. This statement serves as a guiding principle for decision-making and project direction. |
Legal setup of a project allows you to provide information on:
Legal Details
To update legal details for a project, perform the following steps:
Click on the required project and click Project Definition.
Click Edit from the Project Details section to update legal information.
The Edit Legal Details page appears. Update the following details and click Save:
Based on the type of Entity Type selected, the fields will vary accordingly.
Field | Action |
Common Name | The commonly known name of the open source project, such as its abbreviation or nickname. For example, OSSF. You can edit this field on the project definition page. |
Formal Name | Enter the legal name of the project as registered with the relevant authorities. For Example:
|
Legal Parent | This field provides info on the legal entity of the project. The legal entity serves as the parent organization of the project. To select the legal parent use a dropdown menu with predefined options or an autocomplete feature.
|
Parent Project | Enter the parent project under which this project is created. The legal parent entity exercises governance and legal oversight over the entire open source foundation, whereas the project parent entity provides guidance and support to specific projects within the foundation's ecosystem. |
Formation Date | This is the official date when the project is established or incorporated. Select the correct date using the provided calendar tool. |
Dissolution Date | Enter the dissolution date when the project will be terminated. |
Entity Type | This refers to the legal structure or type of entity that the project or foundation is registered as, such as a non-profit organization, corporation, or association. Please select the appropriate entity type from the dropdown menu. Select the required entity type.
|
Incorporation Document | The official document establishing the legal existence of your foundation or project. Upload or enter the incorporation document URL. |
Policies URL | Policies are specific legal policies or guidelines that govern the operations of the open source foundation or projects. You can provide a link to the relevant policy for reference. |
Patent License | Select the license from the dropdown that provides the licensing terms related to patents held by the project or the foundation. |
Notice Date | This is the specific date on which official notices or communications are issued by the open source foundation or projects. It could include notifications about policy updates, organizational changes, or other important announcements |
Primary Open Source License | Indicates the main open source license under which your foundation or project operates. |
Governance Document | You can update the governance document details here. |
Governance Document Enter URL | Enter the governance document URL. |
Manage Services Agreement | When entering details about a Master Service Agreement in your project management tools, enter the URL or upload the agreements that are provided to the foundation or the project by external service providers or vendors who are offering their services to support the foundation's operations or projects. |
Management Services Effective Date | The date when the management services become operational and effective. |
Manage Services Expiration Date | Enter the date when the management services agreement for your foundation or project is scheduled to end. |
You can also provide details related to the branding of the project like uploading the logo for the project and providing brand color and website details.
To update branding and media information for a project, perform the following steps:
Click on the required project and click Project Definition.
Click Edit from the Branding and Media section to update branding and media information.
Click Edit on the Branding &Media details page, update the following details, and click Save:
Field | Action |
Project Logo | You can upload the project logo here. |
Brand Color | You can select the brand color using the color picker. |
Primary Website | Enter the primary website URL. |
Notifications Group | Enter the email where you want notifications to be delivered. |
Social Handles | Provides details related to the social media account links, such as Facebook, Pinterest, YouTube, Reddit, etc. |
Project Setup also lets you update personnel information like executive name, owner details, and program manager details.
To update project staff information for a project, perform the following steps:
Click on the required project and click Project Definition.
Click Edit from the Project Staff section to update project staff information.
The Edit Project Staff dialog box appears. Update the project staff details and click Confirm.
Artifacts allow you to upload or add various project-related artifacts, such as presentations, documents, and other artifacts, to share with member company users.
To add artifacts for a project, perform the following steps:
Click on the required project and click Project Definition.
Click Add from the Artifacts section to add artifacts.
The Add Artifacts dialog box appears. Upload the required artifacts of the project and click Save.