OpenEnergyPlatform · jh-RLI · May 30, 2023 · Nov 18, 2022 · Jan 4, 2023 · Jan 4, 2023
diff --git a/.github/ISSUE_TEMPLATE/issue_template_bug.md b/.github/ISSUE_TEMPLATE/issue_template_bug.md
@@ -0,0 +1,31 @@
+---
+name: Bug Issue
+about: For bugs and errors 
+title: Your title should make sense if said after "The issue is <your issue title>"
+labels: "bug"
+assignees: ''
+
+---
+
+## Description of the issue
+
+Describe the problem in as much detail as possible.
+Focus on the expected and current behavior. 
+If necessary, create a screenshot and insert below.
+
+## Steps to Reproduce
+1.
+2.
+3.
+
+## Ideas of solution
+
+Describe possible ideas for solution and evaluate advantages and disadvantages.
+
+## Context and Environment
+* Version used: 
+* Operating system: 
+* Environment setup and (python) version: 
+
+## Workflow checklist
+- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/develop/CONTRIBUTING.md)
diff --git a/.github/ISSUE_TEMPLATE/issue_template_feature.md b/.github/ISSUE_TEMPLATE/issue_template_feature.md
@@ -0,0 +1,19 @@
+---
+name: Feature Issue
+about: For new ideas, developments and features
+title: Your title should make sense if said after "The issue is <your issue title>"
+labels: "enhancement"
+assignees: ''
+
+---
+
+## Description of the issue
+
+Describe the problem in as much detail as possible. 
+
+## Ideas of solution
+
+Describe possible ideas for solution and evaluate advantages and disadvantages.
+
+## Workflow checklist
+- [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,29 @@
+## Summary of the discussion
+
+Describe the findings of the discussion in the issue or meeting.
+
+## Type of change (CHANGELOG.md)
+
+### Added
+- Add a new class [(#)](https://github.com/OpenEnergyPlatform/oemetadata/pull/)
+
+### Updated
+- Update a definition [(#)](https://github.com/OpenEnergyPlatform/oemetadata/pull/)
+
+### Removed
+- Remove a broken link [(#)](https://github.com/OpenEnergyPlatform/oemetadata/pull/)
+
+
+## Workflow checklist
+
+### Automation
+Closes #
+
+### PR-Assignee
+- [ ] 🐙 Follow the workflow in [CONTRIBUTING.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md)
+- [ ] 📝 Update the [CHANGELOG.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CHANGELOG.md)
+- [ ] 📙 Update the documentation
+
+### Reviewer
+- [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md#40-let-someone-else-review-your-pr)
+- [ ] 🐙 Provided feedback and show sufficient appreciation for the work done
diff --git a/.github/workflows/metadata-test.yml b/.github/workflows/metadata-test.yml
@@ -15,7 +15,7 @@ on:
 
 jobs:
   test:    
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     env:
       TOXENV: py3
     name: metadata-tests
@@ -36,4 +36,4 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements.txt
       - name: Test metadata
-        run: tox -v
+        run: tox -v
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,7 @@ Here is a template for new release sections
 ### Added
 -
 ### Changed
--
+- 
 ### Removed
 -
 
@@ -30,9 +30,24 @@ Here is a template for new release sections
 ## Current
 
 ### Added
--
+
 ### Changed
+
+### Removed
 -
+
+## [1.6.0] - Release - Introduce badges in json schema - 2023-05-30
+
+### Added
+
+- Add badge for all fields [PR#117]
+- Add CITATION.cff with list of authors [(#111)](https://github.com/OpenEnergyPlatform/oemetadata/pull/111)
+
+### Changed
+- Separate examples from descripton and put into its own key-value pair [PR#117]
+- Add issue and PR templates [(#116)](https://github.com/OpenEnergyPlatform/oemetadata/pull/116)
+- Update context field [PR#114]
+
 ### Removed
 -
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,34 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it using these metadata."
+authors:
+  - family-names: "Hülk"
+    given-names: "Ludwig"
+    alias: "@Ludee"
+    website: "https://github.com/Ludee"
+    affiliation: "Reiner Lemoine Institut"
+    orcid: "https://orcid.org/0000-0003-4655-2321"
+  - family-names: "Huber"
+    given-names: "Jonas"
+    alias: "@jh-RLI"
+    website: "https://github.com/jh-RLI"
+    affiliation: "Reiner Lemoine Institut"
+    orcid: "https://orcid.org/0000-0002-6234-0751"
+  - family-names: "Hofmann"
+    given-names: "Christian"
+    alias: "@christian-rli"
+    website: "https://github.com/christian-rli"
+    affiliation: "Reiner Lemoine Institut"
+    orcid: "https://orcid.org/0000-0003-4520-7008"
+  - family-names: "Muschner"
+    given-names: "Christoph"
+    alias: "@chrwm"
+    website: "https://github.com/chrwm"
+    affiliation: "Reiner Lemoine Institut"
+    orcid: "https://orcid.org/0000-0001-8144-5260"
+title: "Open Energy Family - Open Energy Metadata (OEMetadata)"
+type: software
+license: MIT
+version: 1.5.2
+doi: 
+date-released: 2022-11-18
+url: "https://github.com/OpenEnergyPlatform/oemetadata"
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ The oemetadata example and oemetadata template are licensed under [Creative Comm
 
 ## Installation
 
-`pip install oep-metadata`
+`pip install oemetadata`
 
 ## Usage Examples
 

diff --git a/metadata/latest/example.json b/metadata/latest/example.json
@@ -380,7 +380,7 @@
         }
     ],
     "@id": "https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00",
-    "@context": "https://github.com/OpenEnergyPlatform/oemetadata/blob/master/metadata/latest/context.json",
+    "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/develop/metadata/latest/context.json",
     "review": {
         "path": "https://github.com/OpenEnergyPlatform/data-preprocessing/issues",
         "badge": "Platinum"

diff --git a/metadata/latest/metadata_key_description.md b/metadata/latest/metadata_key_description.md
@@ -114,7 +114,7 @@ The JSON format offers different formats:
 |---|---|---|---|
 | 15 | **resources** | An array of objects of the data. It describes the data resource as an individual file or (database) table. |  |
 | 15.1 | profile | The profile of this descriptor according to the profiles specification. This information is retained in order to comply with the "Tabular Data Package" standard. Use "tabular-data-resource" for all tables. | tabular-data-resource |
-| 15.2 | name | A name for the entire data package. To comply with the data package standard it must consist of only lowercase alphanumeric character plus ".", "-" and "_". It may not start with a number. In a database, this will be the name of the table within the  schema containing it. The name usually corresponds to the file name (minus the file-extension) of the data file describing the resource. | openstreetmap.osm_deu_line |
+| 15.2 | name | A name for the entire data package. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. In a database, this will be the name of the table within the schema containing it. The name can correspond to the file name (minus the file-extension) of the data file describing the resource, if it complies with the naming convention above. Name also contains information about the shema on the OEP, use "." to seperate shema from table name. | openstreetmap.osm_deu_line |
 | 15.3 | path | A URL that should be a permanent http(s) address or other path directly linking to the resource. | https://openenergy-platform.org/dataedit/view/openstreetmap/osm_deu_line |
 | 15.4 | format | The file extension. 'csv', 'xls', 'json' etc. would be expected to be the standard file extension for this type of resource. When you upload your data to the OEDB, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data there are stored in a database. | PostgreSQL |
 | 15.5 | encoding | Specifies the character encoding of the resource's data file. The values should be one of the ["Preferred MIME Names"](https://www.iana.org/assignments/character-sets/character-sets.xhtml) for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8. | UTF-8 |
@@ -124,7 +124,7 @@ The JSON format offers different formats:
 |---|---|---|---|
 | 15.6 | **schema** | An object that describes the structure of the present data. It contains all fields (columns of the table), the primary key and optional foreign keys. |  |
 | 15.6.1 | **fields** | An array of objects describing a column and providing name, description, type and unit. | |
-| 15.6.1.1 | name | The name of the field. | year |
+| 15.6.1.1 | name | The name of the field. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. | year |
 | 15.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. |
 | 15.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) |
 | 15.6.1.4 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a seperate field, reference this field. | MW |