You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 SAMM CLI is available here and in GitHub
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 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"
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'
The release date in the Release Note is set to the date of the MS3 approval
- migrated model from BAMM to SAMM
- added missing property "distributionStageAircraftGhgEmissions"
- changed declaration of "productOrSectorSpecificRules" and "geographyRegionOrSubregion" from optional to mandatory
All required reviewers have approved this PR (see reviewers section) --> OK
The new aspect (version) will be implemented by at least one data provider --> OK
The new aspect (version) will be consumed by at least one data consumer --> OK
There exists valid test data --> OK
In case of a new (incompatible) major version to an existing version, a migration strategy has been developed --> OK
The model has at least version '1.0.0' --> OK
The release date in the Release Note is set to the date of the MS3 approval --> OK
MS2_ApprovedChecklist "MS2 Valid Model" is approved.MS3_ApprovedChecklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
tom-rm-meyer-ISST
added
the
MS3_Approved
Description
Adapt existing PCF (Product Carbon Footprint) model as aligned with the Catena-X PCF team and the implementation partners. Changes include
Closes #300
MS2 Criteria
(to be filled out by PR reviewer)
DismantlerIdandDismantlerNameuse an EntityDismantlerwith the propertiesnameandidor use a URN likeio.catenax.dismantler:0.0.1)preferredNameanddescriptionare not the samepreferredNameshould be human readable and follow normal orthography (e.g., no camel case but normal word separation)MS3 Criteria
(to be filled out by semantic modeling team before merge to main-branch)