-
Notifications
You must be signed in to change notification settings - Fork 60
Update PR #1061 with the changes discussed in the FuSa call to make t… #1141
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
base: profile-safety
Are you sure you want to change the base?
Conversation
…ke the profile more reality friendly and implementable by tool creators
stevenc-stb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some Markdown fixes
Nature: is DataProperty or ObjectProperty see format
| @@ -0,0 +1,17 @@ | |||
| SPDX-License-Identifier: Community-Spec-1.0 | |||
|
|
|||
| # requirementRational | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be requirementRationale? If yes, then, also the file name change is needed.
stanislaw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a great, well-focused PR. I really welcome this change!
I only left some smaller suggestions, not changing the overall structure of what is proposed.
(Sorry, I missed to join the FuSa meeting due to the timezone change 🥲 )
|
|
||
| ## Description | ||
|
|
||
| Additional detail used to define the reason/rational, why this requirement is there or give some additional information, needed to understand the requirement. Usually less formal than the requirement wording of the RequirementStatement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here I would add:
Additional detail used to define the reason or justification for the existence of the requirement. The rationale is usually less formal than the wording of the requirement statement itself.
If a requirement is linked to a parent requirement, the rationale shall provide a high-level justification describing how the child requirement satisfies or contributes to fulfilling the intent of the parent requirement. If a requirement has no parent linkage, the rationale shall provide a self-contained explanation of the underlying reasoning or purpose for the requirement — i.e., it shall justify why the requirement is stated as it is.
Note that I removed the additional information because this can be done by using the parent SPDX element fields.
|
|
||
| - gitoid: [Gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid), stands for [Git Object ID](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). A gitoid of type blob is a unique hash of a binary artifact. A gitoid may represent either an [Artifact Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-identifier-types) for the software artifact or an [Input Manifest Identifier](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#input-manifest-identifier) for the software artifact's associated [Artifact Input Manifest](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-input-manifest); this ambiguity exists because the Artifact Input Manifest is itself an artifact, and the gitoid of that artifact is its valid identifier. Gitoids calculated on software artifacts (Snippet, File, or Package Elements) should be recorded in the SPDX 3.0 SoftwareArtifact's contentIdentifier property. Gitoids calculated on the Artifact Input Manifest (Input Manifest Identifier) should be recorded in the SPDX 3.0 Element's externalIdentifier property. See [OmniBOR Specification](https://github.com/omnibor/spec/), a minimalistic specification for describing software [Artifact Dependency Graphs](https://github.com/omnibor/spec/blob/eb1ee5c961c16215eb8709b2975d193a2007a35d/spec/SPEC.md#artifact-dependency-graph-adg). | ||
| - swhid: SoftWare Hash IDentifier, a persistent intrinsic identifier for digital artifacts, such as files, trees (also known as directories or folders), commits, and other objects typically found in version control systems. The format of the identifiers is defined in the [SWHID specification](https://www.swhid.org/specification/v1.1/4.Syntax) (ISO/IEC DIS 18670). They typically look like `swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2`. | ||
| - reqUID: the UID used by a requirements management or any other lifecycle management tool to uniquely identify a requirement item. UID, or unique ID, is a standard term in requirements engineering. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be reqUID or reqUUID? I think the addition of universally unique is very important here.
Also, should it be written as requirementUUID?
| - republishedBy: Designates a `from` Vulnerability's details were tracked, aggregated, and/or enriched to improve context (i.e. NVD) by each `to` Agent. | ||
| - serializedInArtifact: The `from` SpdxDocument can be found in a serialized form in each `to` Artifact. | ||
| - testedOn: The `from` Element has been tested on the `to` Element(s). | ||
| - tracedToDetail: the `from` Requirement has some more detailed implementation information in each `to` Requirement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - tracedToDetail: the `from` Requirement has some more detailed implementation information in each `to` Requirement. | |
| - tracedToDetail: the `from` Requirement is refined and further elaborated by each `to` Requirement, which contains more detailed implementation information. |
|
|
||
| ## Summary | ||
|
|
||
| Text used to define the rational or additional information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Text used to define the rational or additional information. | |
| Text used to describe the rationale of the requirement, explaining the reasoning or justification behind its formulation. |
model/Core/Classes/Requirement.md
Outdated
|
|
||
| ## Description | ||
|
|
||
| A requirement element is a distinct article or unit defining an expectation, need, behaviour, design intent etc. of an item that already exists or is to be created based on this requirement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| A requirement element is a distinct article or unit defining an expectation, need, behaviour, design intent etc. of an item that already exists or is to be created based on this requirement. | |
| A requirement element is a distinct article or unit defining an expectation, need, behaviour, design intent, etc., of an item that already exists or is to be created based on this requirement. |
| @@ -0,0 +1,17 @@ | |||
| SPDX-License-Identifier: Community-Spec-1.0 | |||
|
|
|||
| # devLifeCycleStage | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not a native English speaker but I think we can simply do devLifecycleStage because lifecycle is really one word.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a native English speaker as well and in general I don't have a preference between "LifeCycle" and "Lifecycle" -- but as we already have /Core/LifecycleScopedRelationship, we should keep using "Lifecycle".
Co-authored-by: Stanislav Pankevich <s.pankevich@gmail.com> Signed-off-by: Nicole Pappler <nicole@alektometis.com>
Co-authored-by: Stanislav Pankevich <s.pankevich@gmail.com> Signed-off-by: Nicole Pappler <nicole@alektometis.com>
Co-authored-by: Stanislav Pankevich <s.pankevich@gmail.com> Signed-off-by: Nicole Pappler <nicole@alektometis.com>
Co-authored-by: Stanislav Pankevich <s.pankevich@gmail.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
This is a fix for the .md as per https://github.com/spdx/spdx-3-model/blob/develop/docs/format.md#properties Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
Update PR #1061 with the changes discussed in the FuSa call to make t…he profile more reality friendly and implementable by tool creators
This updates the PR #1061