feature/mx-1347 link cruft template (#6)

# Added
- pull request template
- CHANGELOG file
- cruft template link

# Changes
- harmonized boilerplate

---------

Signed-off-by: Nicolas Drebenstedt <drebenstedtn@rki.de>

.cruft.json

@@ -0,0 +1,14 @@
+{
+  "template": "https://github.com/robert-koch-institut/mex-template",
+  "commit": "c58458330ea33a3c2a2f18662442b92b6e5b5f4d",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "project_name": "editor",
+      "short_summary": "Metadata editor web application.",
+      "long_summary": "The `mex-editor` is an angular application that allows creating and editing rules to non-destructivley manipulate metadata. This can be used to enrich data with manual input or insert new data from scratch.",
+      "_template": "https://github.com/robert-koch-institut/mex-template"
+    }
+  },
+  "directory": null
+}

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+# PR Context
+<!-- Additional info for the reviewer -->
+
+# Added
+<!-- New features and interfaces -->
+
+# Changes
+<!-- Changes in existing functionality -->
+
+# Deprecated
+<!-- Soon-to-be removed features -->
+
+# Removed
+<!-- Definitely removed features -->
+
+# Fixed
+<!-- Fixed bugs -->
+
+# Security
+<!-- Fixed vulnerabilities -->

.github/workflows/cookiecutter.yml

@@ -0,0 +1,32 @@
+name: Cookiecutter
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+env:
+  PIP_NO_OPTION: on
+  PIP_NO_CLEAN: on
+  PIP_PREFER_BINARY: on
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install requirements
+        run: pip install cruft
+
+      - name: Check template
+        run: cruft check

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- pull request template
+- CHANGELOG file
+- cruft template link
+
+### Changes
+
+- harmonized boilerplate
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Robert Koch-Institut
+Copyright (c) 2024 Robert Koch-Institut
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,8 +2,8 @@
 
 Metadata editor web application.
 
-[![linting](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml)
-[![cve-scan](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml)
+[![linting](https://github.com/robert-koch-institut/mex-editor/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-editor/actions/workflows/linting.yml)
+[![cve-scan](https://github.com/robert-koch-institut/mex-editor/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-editor/actions/workflows/cve-scan.yml)
 
 ## project
 
@@ -17,6 +17,10 @@ Via MEx, metadata will be made findable, accessible and shareable, as well as av
 for further research. The goal is to get an overview of what research data is available,
 understand its context, and know what needs to be considered for subsequent use.
 
+RKI cooperated with D4L data4life gGmbH for a pilot phase where the vision of a
+FAIR metadata catalog was explored and concepts and prototypes were developed.
+The partnership has ended with the successful conclusion of the pilot phase.
+
 After an internal launch, the metadata will also be made publicly available and thus be
 available to external researchers as well as the interested (professional) public to
 find research data from the RKI.
@@ -30,14 +34,14 @@ data Findable, Accessible, Interoperable and Reusable.
 
 ## package
 
-The `mex-editor` is an angular application that allows creating and editing
-rules to non-destructivley manipulate metadata. This can be used to enrich data
-with manual input or insert new data from scratch.
+The `mex-editor` is an angular application that allows creating and editing rules to
+non-destructivley manipulate metadata. This can be used to enrich data with manual input
+or insert new data from scratch.
 
 ## license
 
-This package is licensed under the [MIT license](/LICENSE). Other components of the
-MEx project will be released under the same license in the future.
+This package is licensed under the [MIT license](/LICENSE). All other software
+components of the MEx project are open-sourced under the same license as well.
 
 ## development
 

SECURITY.md

@@ -2,13 +2,13 @@
 
 ## Supported Versions
 
-This angular app is currently in pre-release state. That means changes can
+This software package is currently in pre-release state. That means changes can
 occur frequently and only the latest released version will be supported with
-security and bug fixes. It is therefore not recommended to use this app in
+security and bug fixes. It is therefore not recommended to use this package in
 productive environments.
 
 ## Reporting a Vulnerability
 
 If you discover a vulnerability, please contact the author team directly via
-[email](package.json). Pull-requests with proposed solutions are explicitly
+[email](mailto:mex@rki.de). Pull-requests with proposed solutions are explicitly
 welcomed as well.