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

change bamm to samm #760

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

change bamm to samm #760

wants to merge 8 commits into from

Conversation

gautam-e
Copy link

@gautam-e gautam-e commented Jun 18, 2024

Description

This addresses #744. bamm has been renamed to samm and the version has been bumped (patch).

-->

Closes #744

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

@agg3fe
Copy link
Contributor

agg3fe commented Jun 20, 2024

@gautam-e The version for this model should be major update, means it should be 3.0.0 (as 2.0.0 was already removed).
Also, please update io.catenax.bom_as_specified/RELEASE_NOTES.md for this new model.

@gautam-e
Copy link
Author

@agg3fe changes done. Please check if ok.

Copy link

@jSchuetz88 jSchuetz88 left a comment

Choose a reason for hiding this comment

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

Thank you for updating the BAMM version to SAMM. From my side only minor changes are requested regarding:

  • 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
  • preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
  • all properties with an simple type have an example value


:IdentifierCharacteristic a samm:Characteristic;
samm:preferredName "IdentifierCharacteristic"@en;
samm:dataType xsd:string .

This comment was marked as resolved.

Copy link
Author

Choose a reason for hiding this comment

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

@jSchuetz88 do you know where I can get this from?

Copy link
Author

Choose a reason for hiding this comment

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

I have made changes except for the example part

Copy link
Author

Choose a reason for hiding this comment

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

@jSchuetz88 I need help here. Don't know what to do.

Copy link

@jSchuetz88 jSchuetz88 Jun 22, 2024

Choose a reason for hiding this comment

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

Thank you for addressing the comments. And sorry for the confusion, this characteristic does not need to provide an example value.

This comment is resolved from my side.

:partDescription a samm:Property;
samm:preferredName "part description"@en;
samm:description "The description of the part in the primary language of the production facility of the product owner."@en;
samm:characteristic samm-c:Text .

Choose a reason for hiding this comment

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

No description provided for simple type.

Copy link
Author

Choose a reason for hiding this comment

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

@jSchuetz88 I need help here. Don't know what to do.

Copy link

@jSchuetz88 jSchuetz88 Jun 22, 2024

Choose a reason for hiding this comment

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

Sorry, i meant "no example value provided". Unfortunately I lack the business knowledge in that case. Based on other semantic models, it could be something like:

the example from the PCF data model:

samm:exampleValue "Ethanol, 95% solution" .

or an other one from: SingleLevelBomAsSpecified

samm:exampleValue "The steering wheel is nice and round".

io.catenax.bom_as_specified/3.0.0/BomAsSpecified.ttl Outdated Show resolved Hide resolved
@gautam-e
Copy link
Author

@jSchuetz88 I have made the changes that I can make. I would need some help for the remaining suggestions.

@agg3fe
Copy link
Contributor

agg3fe commented Jun 21, 2024

@gautam-e Could you please check eclipsefdn/eca step in the work flow. Looks like you have not signed it.

@agg3fe
Copy link
Contributor

agg3fe commented Jun 27, 2024

@gautam-e Could you please join the Weekly Monday meeting. We can discuss the Pull Request and provide approval. Let me know if you have meeting invite or not.

@gautam-e
Copy link
Author

gautam-e commented Jul 1, 2024

@gautam-e Could you please join the Weekly Monday meeting. We can discuss the Pull Request and provide approval. Let me know if you have meeting invite or not.

@agg3fe I don't have the Monday appointment.

@jSchuetz88
Copy link

@gautam-e Could you please join the Weekly Monday meeting. We can discuss the Pull Request and provide approval. Let me know if you have meeting invite or not.

@agg3fe I don't have the Monday appointment.

Hi @gautam-e, sorry for the late reply. If you provide me your E-Mail-Adress, I will invide you to the meeting?

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 Issue]: bamm instead of samm in bom_as_specified
3 participants