Skip to content

Commit

Permalink
Add Document work item description in the document project
Browse files Browse the repository at this point in the history
Signed-off-by: Luigi Pellecchia <[email protected]>
  • Loading branch information
Luigi Pellecchia committed Sep 2, 2024
1 parent 0b1e002 commit 600075b
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions docs/source/work_items.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Work Items
-------------
Justification
-------------

Often used to highlight the reason why a section of the Specification Document can't be related to any other work item type.

Default Fields:
Expand All @@ -23,6 +22,30 @@ Possible Children Work Item Types:

+ None

--------
Document
--------
Document is a general purpose work item that allow users to specify all relationships supported by SPDX.
BASIL distinguishes between text files and other files.
In case of text files, user can specify also a snippet of the document.
Moreover in that case BASIL automatically validate the relationships checking that the selected section still exists at the target offset.
This way user can be notified in case of changes.

Default Fields:

+ title
+ description
+ document_type (file or text)
+ status
+ spdx_relation
+ url
+ section (only in case of text file)
+ offset (only in case of text file)

Possible Children Work Item Types:

+ None

--------------------
Software Requirement
--------------------
Expand Down Expand Up @@ -79,7 +102,6 @@ Possible Children Work Item Types:
----------------
Work Item Status
----------------

BASIL support following status for above mentioned work items:

+ NEW
Expand Down

0 comments on commit 600075b

Please sign in to comment.