Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Adding some additional text #2

Open
jhdalek55 opened this issue Sep 25, 2019 · 2 comments
Open

Adding some additional text #2

jhdalek55 opened this issue Sep 25, 2019 · 2 comments

Comments

@jhdalek55
Copy link

jhdalek55 commented Sep 25, 2019

This probably doesn't need to be an issue, but I wanted to list these proposed additions to this repo so they are not forgotten or lost along the way.

I believe we need an introduction that provides the rationale behind adopting the test procedure.

I think a listing of the MUSTs and SHALLs from the Standard would clarify the exact elements the tests are designed to measure.

I think some background on how the initial tests were conducted would be helpful in framing the choice of tests. Note that on the 9/17 phone call Cameron Mott agreed to do a first cut of this text.

@lukpueh
Copy link

lukpueh commented Sep 26, 2019

That's exactly what an issue is for. 👍

@jhdalek55
Copy link
Author

We now have the "Musts and Shalls" from the Standard posted on the repo as requirements." Thanks, Priyanka.
Some edits are needed:
``

  1. you don't need an apostrophe in "Musts." Instead, make MUST and SHALL all uppercase, and make the plural 's' lowercase (MUSTs)

  2. "Reference" in the left-hand column is missing the second "e."

  3. The word "Control" should be centered, not flush right. The text in that box should be flush left, not flush right. Text in "Reference Number" column should be centered.

  4. I'm not sure what "Domain" means. If it is referring to the section or subsection of the Standard, the title should be "Section." And why do you call the third column "Control"? "Context" might be a better word.

  5. The first two points here are "requirements" in terms of broad goals. They are not technical "MUSTs and SHALLs" which refer to specific design elements or steps that must be taken. I think, instead of including this in the table, they should be included in a brief section intro. I will do a separate pull request with suggested text.

  6. If you are running partial sentences in the "Control" column, please indicate they are incomplete with an ellipsis (...)

  7. In 5.2.1, moving from bulleted text in the document to one sentence here makes this potentially confusing. For the public key identifier (the 15th item I believe) please present it as follows: "A public key identifier is EITHER all of the following—(a) The value of the public key itself (b) the public key cryptographic algorithm, and (c) the particular scheme used to verify the signature—OR a secure hash over at least the above components."

  8. Use the same set-up as above for all the items in this section that are lists of elements. Otherwise the syntax gets very confusing.

  9. In 5.2.3.1., there is some messy spacing. This might be corrected when this is set up as flush left, but words can't be on top of each other. Also, here and elsewhere, if you move a bulleted list into a paragraph, you generally don't capitalize the first word.

  10. In 5.4.2.1.1 Watch out for weird capitalizations. i.e. "A Payload Containing" should be "A payload containing..."

  11. 5.4.2.4 Targets role...the name of roles, repositories, metadata is capitalized.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants