Skip to content

Commit a5a6349

Browse files
LucaFgrThomasClausnitzer
authored andcommitted
Added TODOs/Comments to TA-Behaviours and TA-Constraints Context files
1 parent 03d7107 commit a5a6349

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

TSF/trustable/assertions/TA-BEHAVIOURS_CONTEXT.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ sufficient.
5151
- **Answer**: The Expectations are provided via JLEX-01 and JLEX-02.
5252
- Argument of sufficiency for break-down of expected behaviour for all
5353
Expectations
54-
- **Answer**: # TODO: Not sure how to argument here. There is now way to prove that.
54+
- **Answer**: TODO: Create a new statement JLS-56 about sufficiency of break-down and reference JLEX-01 and JLEX-02.
5555
- Validation and verification of expected behaviour
56-
- **Answer**: The validation and verification of expected behaviour is done via the evidence provided for all the statements below JLEX-01 and JLEX-02 in the trustable graph.
56+
- **Answer**: The validation and verification of expected behaviour is done via the evidence provided for all the statements below JLEX-01 and JLEX-02 in the trustable graph. TODO reference JLS-03.
5757

5858

5959
**Confidence scoring**
@@ -71,20 +71,20 @@ and that the resulting system and tests are validated by appropriate strategies.
7171
- Could some participants have incentives to manipulate information?
7272
- **Answer**: We cannot imagine any incentive to manipulate information.
7373
- Could there be whole categories of Expectations still undiscovered?
74-
- **Answer**: It is currently unlikely that there are whole categories of Expectations still undiscovered.
74+
- **Answer**: It is currently unlikely that there are whole categories of Expectations still undiscovered. TODO mention SME reviews increase confidence
7575
- Can we identify Expectations that have been understood but not specified?
7676
- **Answer**: There are currently no Expectations that have been understood but not specified.
7777
- Can we identify some new Expectations, right now?
7878
- **Answer**: Currently we cannot identify any new Expectations.
7979
- How confident can we be that this list covers all critical requirements?
8080
- **Answer**: We are very confident that this list covers all critical requirements.
81-
- How comprehensive is the list of tests?
81+
- How comprehensive is the list of tests?
8282
- **Answer**: Currently, the branch coverage is 93.865% and the line coverage is 99.186%, cf. JLS-27. Therefore, we deem the list of tests to be very comprehensive.
8383
- Is every Expectation covered by at least one implemented test?
8484
- **Answer**: Yes, both of the Expectations are covered by at least one implemented test.
8585
- Are there any Expectations where we believe more coverage would help?
8686
- **Answer**: No, the coverage is already on a high level and no further gains are expected by further increasing the coverage.
8787
- How do dependencies affect Expectations, and are their properties verifiable?
88-
- **Answer**: The nlohmann/json library does not have external dependencies, so that there are none that could possibly affect the Expectations.
88+
- **Answer**: The nlohmann/json library does not have external dependencies, so that there are none that could possibly affect the Expectations. TODO say that this doesnt apply to testing
8989
- Are input analysis findings from components, tools, and data considered in relation to Expectations?
90-
- **Answer**: Not that we know of.
90+
- **Answer**: TODO ask in libera chat or look through TA-Behaviours

TSF/trustable/assertions/TA-CONSTRAINTS_CONTEXT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ reporting bugs, issues, and requests.
5353
- Installation manuals with worked examples
5454
- **Answer**: See JLS-70.
5555
- Configuration manuals with worked examples
56-
- **Answer**: See JLS-71.
56+
- **Answer**: See JLS-71. TODO adapt JLS-71 with sources for configuration.
5757
- Specification documentation with a clearly defined scope
58-
- **Answer**: See JLS-72.
58+
- **Answer**: See JLS-72. TODO check what a specification documentation actually is and whether this is covered by JLS-72 (the design goals reference)
5959
- User guides detailing limitations in interfaces designed for expandability or modularity
60-
- **Answer**: #TODO
60+
- **Answer**: #TODO answers. Expandability is not restricted, there is also no user guide about that.
6161
- Documented strategies used by external users to address constraints and work with existing Statements
62-
- **Answer**: see AOU-10 and AOU-11.
62+
- **Answer**: see AOU-10 and AOU-11. TODO search for possible additoinal AOUs to mention here.
6363

6464
**Confidence scoring**
6565

@@ -70,21 +70,21 @@ contradictions and obvious pitfalls within the defined Statements.
7070

7171
- Are the constraints grounded in realistic expectations, backed by real-world
7272
examples?
73-
- **Answer**: The constraints originate from S-CORE, the nlohmann/json library and the RFC-8259 standard. As these are all widely used, the constraints are grounded in realistic expectations.
73+
- **Answer**: The constraints originate from S-CORE, the nlohmann/json library and the RFC-8259 standard. As these are all widely used, the constraints are grounded in realistic expectations. TODO think about what constraints are meant here
7474
- Do they effectively guide downstream consumers in expanding upon existing
7575
Statements?
7676
- **Answer**: The existing set of AOUs provides effective guidance for consumers.
7777
- Do they provide clear guidance for upstreams on reusing components with
7878
well-defined claims?
79-
- **Answer**: # TODO
79+
- **Answer**: # TODO not clear what an upstream is in our case
8080
- Are any Statements explicitly designated as not reusable or adaptable?
8181
- **Answer**: No, all statements could theoretically be adapted or reused.
8282
- Are there worked examples from downstream or upstream users demonstrating
8383
these constraints in practice?
8484
- **Answer**: As the nlohmann/json library is widely used, its constraints (like the installation manual) are regurlarly read and applied and therefore demonstrated.
8585
- Have there been any documented misunderstandings from users, and are these
8686
visibly resolved?
87-
- **Answer**: Yes, it is documented that the [brace initialisation](https://json.nlohmann.me/home/faq/) (cf. AOU-06) regularly leads to confusion, cf. [here](https://github.com/nlohmann/json/issues/4898).
87+
- **Answer**: Yes, it is documented that the [brace initialisation](https://json.nlohmann.me/home/faq/) (cf. AOU-06) regularly leads to confusion, cf. [here](https://github.com/nlohmann/json/issues/4898). TODO look for further misunderstandings
8888
- Do external users actively keep up with updates, and are they properly
8989
notified of any changes?
9090
- **Answer**: External users of the library are not necessarily automatically notified of an update, and are neither assumed nor required to keep up to date. If the external user forks the github repository, however, then github shows automatically whenever the upstream changes.

0 commit comments

Comments
 (0)