Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata.Json Standaradize for Trace Models #440

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

jonbckr
Copy link
Contributor

@jonbckr jonbckr commented Nov 1, 2023

Description

Changed the status in the metadata.json to 'Standardize', for standardized Traceability aspect models.

-->

Closes #439

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the SAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar samm-cli.jar aspect <path-to-aspect-model> validate ). The SAMM CLI is available here and in GitHub
  • use Camel-Case (e.g., "MyModelElement" or "TimeDifferenceGmtId", when in doubt follow https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
  • the identifiers for all model elements start with a capital letter except for properties
  • the identifier for properties starts with a small letter
  • all model elements at least contain the fields "preferred name" and "description" in English language. The description must be comprehensible. It is not required to write full sentences but style should be consistent over the whole model
  • Property and the referenced Characteristic should not have the same name
  • the versioning in the URN follows semantic versioning, where minor version bumps are backwards compatible and major version bumps are not backwards compatible.
  • use abbreviations only when necessary and if these are sufficiently common
  • avoid redundant prefixes in property names (consider adding properties to an enclosing Entity or even adapt the namespace of the model elements, e.g., instead of having two properties DismantlerId and DismantlerName use an Entity Dismantler with the properties name and id or use a URN like io.catenax.dismantler:0.0.1)
  • fields preferredName and description are not the same
  • preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
  • name of aspect is singular except if it only has one property which is a Collection, List or Set. In theses cases, the aspect name is plural.
  • units are referenced from the SAMM unit catalog whenever possible
  • use constraints to make known constraints from the use case explicit in the aspect model
  • when relying on external standards, they are referenced through a "see" element
  • all properties with an simple type have an example value
  • metadata.json exists with status "release"
  • generated json schema validates against example json payload
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes
  • all contributors to this model are mentioned in copyright header of model file

MS3 Criteria

(to be filled out by semantic modeling team before merge to main-branch)

  • All required reviewers have approved this PR (see reviewers section)
  • The new aspect (version) will be implemented by at least one data provider
  • The new aspect (version) will be consumed by at least one data consumer
  • There exists valid test data
  • In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
  • The model has at least version '1.0.0'
  • If a previous model exists, model deprecation has been checked for previous model
  • The release date in the Release Note is set to the date of the MS3 approval

@jonbckr
Copy link
Contributor Author

jonbckr commented Nov 1, 2023

modeling_team

@jonbckr
Copy link
Contributor Author

jonbckr commented Nov 1, 2023

@@ -1 +1 @@
{ "status" : "release"}
{ "status" : "standardize"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the models which are going to be standardize, we need to convert them to SAMM model. as this model is still written in BAMM, can you please change this to SAMM and raise new PR.

@@ -1 +1 @@
{"status":"release"}
{"status":"standardize"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same BAMM to SAMM conversion required here also.

@@ -1 +1 @@
{ "status" : "release"}
{ "status" : "standardize"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same BAMM to SAMM conversion required here also.

@agg3fe
Copy link
Contributor

agg3fe commented Nov 7, 2023

@jonbckr We need to convert three models from your request to SAMM from BAMM. This is important for us. Could you please check this and initiate this.

@johannsvarela
Copy link
Contributor

johannsvarela commented Nov 7, 2023

@jonbckr We need to convert three models from your request to SAMM from BAMM. This is important for us. Could you please check this and initiate this.

@agg3fe we plan to adapt the mentioned aspect models in the next sprints, so that we can include the migration from BAMM to SAMM within these stories:

The adaptation of these aspect models will start earliest in the next sprint PI11 S2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Model Standardization]: Summarized issue including all standardized Traceability Models
3 participants