From 511238095b50fb6c11263869a395a38a094c890f Mon Sep 17 00:00:00 2001 From: Johannes Kristan Date: Thu, 29 Jun 2023 13:14:56 +0200 Subject: [PATCH 1/4] Add template for standardization issue --- .../ISSUE_TEMPLATE/model_standardize_request.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/model_standardize_request.md diff --git a/.github/ISSUE_TEMPLATE/model_standardize_request.md b/.github/ISSUE_TEMPLATE/model_standardize_request.md new file mode 100644 index 00000000..193b7607 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/model_standardize_request.md @@ -0,0 +1,16 @@ +--- +name: Model Standardized Request +about: File a request to mark an existing model as standardized +title: '[Model Standardization]: ' +labels: standardize + +--- + +## Link to Standards Document + + +## MS1 Criteria + +- [ ] The model that is used in a standard exists +- [ ] The model is in status "release" +- [ ] The model is not yet in status "standardize" From 542072fe9f643c3e214f54fef93eaf23d6a34d10 Mon Sep 17 00:00:00 2001 From: Johannes Kristan Date: Mon, 3 Jul 2023 16:22:18 +0200 Subject: [PATCH 2/4] refine check items --- .github/ISSUE_TEMPLATE/model_standardize_request.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/model_standardize_request.md b/.github/ISSUE_TEMPLATE/model_standardize_request.md index 193b7607..98710dc5 100644 --- a/.github/ISSUE_TEMPLATE/model_standardize_request.md +++ b/.github/ISSUE_TEMPLATE/model_standardize_request.md @@ -11,6 +11,7 @@ labels: standardize ## MS1 Criteria -- [ ] The model that is used in a standard exists +- [ ] The model exists +- [ ] There is a [Catena-X standard](https://catena-x.net/de/standard-library) referencing this model - [ ] The model is in status "release" - [ ] The model is not yet in status "standardize" From aad92828815e993ef8d4b2f0fb518953cf080eed Mon Sep 17 00:00:00 2001 From: Johannes Kristan Date: Mon, 3 Jul 2023 16:28:20 +0200 Subject: [PATCH 3/4] Add check item for standard document link --- .github/ISSUE_TEMPLATE/model_standardize_request.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/model_standardize_request.md b/.github/ISSUE_TEMPLATE/model_standardize_request.md index 98710dc5..a860e654 100644 --- a/.github/ISSUE_TEMPLATE/model_standardize_request.md +++ b/.github/ISSUE_TEMPLATE/model_standardize_request.md @@ -15,3 +15,4 @@ labels: standardize - [ ] There is a [Catena-X standard](https://catena-x.net/de/standard-library) referencing this model - [ ] The model is in status "release" - [ ] The model is not yet in status "standardize" +- [ ] Release note entry for model version referenced in standard received link to standard document From b0b57d837c952c357c92624c08a5fd7d9a1612ac Mon Sep 17 00:00:00 2001 From: Johannes Kristan Date: Tue, 4 Jul 2023 15:33:23 +0200 Subject: [PATCH 4/4] Update GOVERNANCE.md Add section about status standardize to governance process --- documentation/GOVERNANCE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/documentation/GOVERNANCE.md b/documentation/GOVERNANCE.md index e4465bca..bfd50293 100644 --- a/documentation/GOVERNANCE.md +++ b/documentation/GOVERNANCE.md @@ -59,6 +59,12 @@ Thus, if you want to mark an issue or a PR, please add the aforementioned labels Modeling_Team ``` to the PR. We have filters, which check for such comments. + +## Standardizing a model +If a model is used in a standard, this should be indicated by changing the status of the model to status "STANDARDIZED". +A model with can only reach status "STANDARDIZED" if it is "RELEASED" beforehand. +A model with status "STANDARDIZED" can only be moved to status "DEPRECATED" if the corresponding standard is "DEPRECATED" as well. + ## Retiring a model Once a model gets the status "DEPRECATED" it should not be used anymore by new use cases. Existing applications should look for a way to migrate to an alternative version or model. In alignment with the overall release cycles of Tractus-X, the modeling team tags the current main branch with the corresponding Tractus-X release and publishes modeling release notes. These release notes contain a hint about all model versions that changed the status to "DEPRECATED" since the previous Tractus-X release. The modeling team will delete these models two Tractus-X releases cycles later. So use cases are advised to react to the deprecation of models within the next release cycle.