Skip to content

Commit

Permalink
Merge pull request #210 from bci-oss/add_template_for_standardize_issue
Browse files Browse the repository at this point in the history
Add template for standardization issue
  • Loading branch information
bs-jokri authored Jul 4, 2023
2 parents 6cb7e06 + 8b32b2f commit acee30f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/model_standardize_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Model Standardized Request
about: File a request to mark an existing model as standardized
title: '[Model Standardization]: '
labels: standardize

---

## Link to Standards Document
<!-- Please link the standard here, where the model is referenced -->

## MS1 Criteria
<!-- This checklist is filled by the issue reviewer -->
- [ ] 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"
- [ ] Release note entry for model version referenced in standard received link to standard document
6 changes: 6 additions & 0 deletions documentation/GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit acee30f

Please sign in to comment.