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

[New Model] Transmission Pass #132

Merged
merged 13 commits into from
May 8, 2023
Merged

[New Model] Transmission Pass #132

merged 13 commits into from
May 8, 2023

Conversation

catroest
Copy link
Contributor

@catroest catroest commented Mar 31, 2023

Description

Integrates comments from #112 and #116

-->

Closes #93

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). The BAMM 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 "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a 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 BAMM 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"
  • file RELEASE_NOTES.md exists and contains entries for proposed model changes

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'

@catroest catroest mentioned this pull request Mar 31, 2023
24 tasks
@catroest catroest changed the title Transmission Pass [New Model] Transmission Pass Mar 31, 2023
@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Mar 31, 2023
@bs-jokri
Copy link
Contributor

@catroest could you have a look into my comments? I found minor things, which not hinder ms2 but might be good to be fixed.

@catroest
Copy link
Contributor Author

@catroest could you have a look into my comments? I found minor things, which not hinder ms2 but might be good to be fixed.

Yes, I read every comment and I think I fixed everything.

The only thing I would like to keep are the property prferred name. I would like to keep only the first word as uppercase. This is because I often use the same name for the property and the description, I wouldn't like for the preferred names to be the same.

Do you mean something else?

@catroest
Copy link
Contributor Author

catroest commented Apr 3, 2023

Modeling_Team ready for MS3

@catroest
Copy link
Contributor Author

catroest commented Apr 18, 2023

before merge into main:

@bs-jokri bs-jokri added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label May 8, 2023
@bs-jokri bs-jokri merged commit bb1f5b4 into eclipse-tractusx:main May 8, 2023
@catroest catroest deleted the Transmission2 branch May 25, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[New Model]: TransmissionPass
2 participants