Merge pull request #157 from OpenEnergyPlatform/feature-137-contributors

Update the contributors section #137 #142 #151
OpenEnergyPlatform · Oct 14, 2024 · a06b6be · a06b6be
2 parents 22f1dc4 + 18f7859
commit a06b6be
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,9 @@ Here is a template for new release sections
   - We use json schema $ref elements to reference the schema modules and we provide code to resolve the reference´s and generate the complete schema.json.
 
 - Add code to generate a example.json based on the schema.json. We read the example values for each of the fields specified in the schema and generate the example. [#???](https://github.com/OpenEnergyPlatform/oemetadata/pull/)
+- Add path to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+- Add organization to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+- Add roles to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
 
 ### Changed
 
@@ -49,7 +52,7 @@ Here is a template for new release sections
 
 ### Removed
 
--
+- Remove email from contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
 
 ## [1.6.0] - Release - Introduce badges in json schema - 2023-05-30
 

diff --git a/metadata/v200_draft/build_source/schemas/provenance.json b/metadata/v200_draft/build_source/schemas/provenance.json
@@ -8,30 +8,57 @@
             "type": "object",
             "properties": {
                 "contributors": {
-                    "description": "A list of objects that describe contributors and contributions. It contains title, email, date, object and comment.",
+                    "description": "A list of objects that describe contributors and contributions. It contains title, path, organization, roles, date, object and comment.",
                     "type": "array",
                     "items": {
                         "type": "object",
                         "properties": {
                             "title": {
-                                "description": "Name/title of the contributor (name for a person, name or title for an organization).",
-                                "example": "John Doe",
+                                "description": "A full Name of the contributor.",
+                                "example": "Ludwig Hülk",
                                 "type": [
                                     "string",
                                     "null"
                                 ],
                                 "badge": null,
                                 "title": "Title"
                             },
-                            "email": {
-                                "description": "E-mail address of the contributor.",
-                                "example": "contact@example.com",
+                            "path": {
+                                "description": "A qualified URL pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID.",
+                                "example": "https://github.com/Ludee",
                                 "type": [
                                     "string",
                                     "null"
                                 ],
                                 "badge": null,
-                                "title": "Email"
+                                "title": "Path"
+                            },
+                            "organization": {
+                                "description": "A string describing the organization this contributor is affiliated to. This can be relevant for the copyright.",
+                                "example": "Reiner Lemoine Institut",
+                                "type": [
+                                    "string",
+                                    "null"
+                                ],
+                                "badge": null,
+                                "title": "Organization"
+                            },
+                            "roles": {
+                                "description": "An array of strings describing the roles of the contributor.",
+                                "example": "[creator, dataCurator]",
+                                "type": "array",
+                                "items": {
+                                    "description": "A role is RECOMMENDED to follow an established vocabulary, such as DataCite Metadata Schema’s contributorRole or CreDIT. Useful roles to indicate are: creator, contact, and dataCurator.",
+                                    "example": "creator",
+                                    "type": [
+                                        "string",
+                                        "null"
+                                    ],
+                                    "badge": null,
+                                    "title": "Role"
+                                },
+                                "badge": null,
+                                "title": "Roles"
                             },
                             "date": {
                                 "description": "Date of the contribution. If the contribution took more than a day, use the date of the final contribiution. Date Format is ISO 8601.",
@@ -76,4 +103,4 @@
             "additionalProperties": false
         }
     }
-}
+}
diff --git a/metadata/v200_draft/metadata_key_description.md b/metadata/v200_draft/metadata_key_description.md
@@ -103,11 +103,13 @@ The JSON format offers different formats:
 |#|Key |Description |Example |
 |---|---|---|---|
 | 14 | **contributors** | An array of objects of the people or organizations who contributed to the data or metadata. Each object refers to one contributor. Every contributor must have a title and property. The path, email, role and organization properties are optional. |  |
-| 14.1 | title | A name of the contributor. | Ludwig Hülk |
-| 14.2 | email | A email address of the contributor or GitHub handle. | @Ludee |
+| 14.1 | title | A full Name of the contributor. | Ludwig Hülk |
+| 14.2 | path | A qualified URL pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID. | https://github.com/Ludee |
+| 14.2 | organization | A string describing the organization this contributor is affiliated to. This can be relevant for the copyright. | Reiner Lemoine Institut |
+| 14.2 | roles | An array of strings describing the roles of the contributor. A role is RECOMMENDED to follow an established vocabulary, such as DataCite Metadata Schema’s contributorRole or CreDIT. Useful roles to indicate are: creator, contact, and dataCurator. | creator, dataCurator |
 | 14.3 | date | The date of the contribution. If the contribution took more than a day, use the date of the final contribiution. Date Format is ISO 8601. | 2016-06-16 |
 | 14.4 | object | The target of the contribution. Which part of the package was supplied or changed. Can be the data, metadata or both (data and metadata). | data and metadata |
-| 14.5 | comment | A free text commentary on what has been done.  | Fixed a typo in the title. |
+| 14.5 | comment | A free text commentary on what has been done.  | Updated the description. |
 
 ### Resource Keys
 |#|Key |Description |Example |