Add documentation for core-team

Signed-off-by: Luigi Gubello <[email protected]>

examples/security-insights-sample.yml

@@ -12,6 +12,9 @@ project-lifecycle:
   status: active
   roadmap: https://foo.bar/roadmap.html
   bug-fixes-only: false
+  core-maintainers:
+  - github:example
+  - [email protected]
   core-team:
   - name: Alice White
     contact: github:example

security-insights-schema.yaml

@@ -67,11 +67,24 @@ properties:
                 $id: '#/properties/project-lifecycle/properties/bug-fixes-only'
                 description: 'Maintainers fix bugs without implementing new features. The project is in Maintenance Mode.'
                 type: boolean
+            core-maintainers:
+                $id: '#/properties/project-lifecycle/properties/core-maintainers'
+                description: |
+                    [Deprecation notice] `core-maintainers` will be deprecated in the next versions.
+                    Maintainers contacts (e-mail, Twitter, etc).
+                additionalItems: false
+                items:
+                    $id: '#/properties/project-lifecycle/properties/core-maintainers/items'
+                    anyOf:
+                    -   $id: '#/properties/project-lifecycle/properties/core-maintainers/items/anyOf/0'
+                        type: string
+                type: array
+                uniqueItems: true
             core-team:
                 $id: '#/properties/project-lifecycle/properties/core-team'
-                description: >
-                    Each core team member must have either a contact or a uri to a document. 
-                    This rule must be enforced by the tool or process using this schema.
+                description: |
+                    Maintainers or team contacts (e-mail, Mastodon, Discord, web pages, etc).
+                    Each core team member must have either a contact or a URI to a document or webpage. 
                 additionalItems: false
                 items:
                     $id: '#/properties/project-lifecycle/properties/core-team/items'

specification.md

@@ -81,6 +81,11 @@ project-lifecycle:
   core-maintainers:
   - https://github.com/github
   - [email protected]
+  core-team:
+  - name: Alice White
+    contact: github:example
+  - name: Joe Dohn
+    contact: [email protected]
   release-cycle: https://foo/release
   release-process: |
       foo bar
@@ -89,10 +94,25 @@ project-lifecycle:
 - `bug-fixes-only` (Required)
   - **Description:** Provide the maintenance status of the project by specifying if the maintainers fix only bugs without providing new features.
   - **Type:** Boolean.
-- `core-maintainers` (Conditionally required)
-  - **Description:** Provide the contacts of the project maintainers (emails, social profiles, websites, etc). This information can help consumers to contact the right people.
+- `core-maintainers`
+  - **Description:** [Deprecation notice] _`core-maintainers` will be deprecated in the next versions._ Provide the contacts of the project maintainers (emails, social profiles, websites, etc). This information can help consumers to contact the right people.
   - **Type:** Array. Elements of the array are strings.
-  - **Condition:** This value is required if `bug-fixes-only` is `true` or if `status` is `active`.
+- `core-team` (Conditionally required)
+  - **Description:** Provide the contacts of the project maintainers (emails, social profiles, websites, etc) or team (web-pages, group e-mails, mailing list, etc). This information can help consumers to contact the right people.
+  - **Type:** Array.
+  - `name`
+    - **Description:** The name of the maintainer or the team.
+    - **Type:** String.
+  - `role`
+    - **Description:** Role of the maintainer in the project.
+    - **Type:** String.
+  - `contact` (Conditional required)
+    - **Description:** Contact of the maintaner or team (e.g. e-mail, Discord, mailing list, etc).
+    - **Type:** String.
+  - `uri` (Conditional required)
+    - **Description:** URI to the team page or team contact information (e.g. mail form page).
+    - **Type:** String. 
+  - **Condition:** This value `core-team` is required if `bug-fixes-only` is `true` or if `status` is `active`. At least one between `contact` and `uri` is required. 
 - `roadmap`
   - **Description:** URI to the project roadmap.
   - **Type:** String. The provided URL must meet the IRI standard (RFC 3987) and begin with `https://`.