Add item numbers to quality declaration template#244
Conversation
Signed-off-by: maryaB-osr <marya@openrobotics.org>
chapulina
left a comment
There was a problem hiding this comment.
There's not an exact 1-to-1 mapping for each item and declaration section, and some of the items don't come up at all, which makes it seem like the template isn't a good representation of the requirements
I'm in favour of listing all the requirements on the template. The template is just a suggestion, I think we're not planning to be strict about the declarations following the template, right? So packages can always choose to combine requirements into single items as they wish. But I feel like it's important that every requirement is listed.
There's no context in the template alone (or in any quality declaration) for those item numbers
Good point. I still feel like the numbers are a powerful way to make sure we're all speaking about the same items, and not skipping any of them. What if each number / header on the template linked directly to that item on the final REP? Is it overkill to list them in such a way that each item gets a URL?
Signed-off-by: maryaB-osr <marya@openrobotics.org>
|
@chapulina I was going to try the links you suggested in another commit, so not merging just yet :) |
|
Thanks, @maryaB-osr ! I just approved so you know I'm fine either way. Your call 😉 |
Signed-off-by: maryaB-osr <marya@openrobotics.org>
Signed-off-by: maryaB-osr <marya@openrobotics.org>
I know you already approved @chapulina but just for the sake of documenting it, we can link to the items on the final rep from the QD, but that would only work if we took the template out of the code block it's in now (otherwise the links show up as literal links). But, taking it out of the code block makes the template look really weird IMO, so I decided against it. |
* initial commit of new rep-2004 Signed-off-by: William Woodall <william@osrfoundation.org> * update my (wjwwood's) email addresses, because the rep script only allows one per person Signed-off-by: William Woodall <william@osrfoundation.org> * fixup copyright/license statements Signed-off-by: William Woodall <william@osrfoundation.org> * REP 2004 extras (#235) * REP 2004 extras Signed-off-by: maryaB-osr <marya@openrobotics.org> * possible chart structure and license question Signed-off-by: maryaB-osr <marya@openrobotics.org> * comment out chart Signed-off-by: maryaB-osr <marya@openrobotics.org> * restructure and edits Signed-off-by: maryaB-osr <marya@openrobotics.org> * fixed a header Signed-off-by: maryaB-osr <marya@openrobotics.org> * add chart Signed-off-by: maryaB-osr <marya@openrobotics.org> * q. level 3 testing in wrong order Signed-off-by: maryaB-osr <marya@openrobotics.org> * level 3 3.v.a mistake Signed-off-by: maryaB-osr <marya@openrobotics.org> * moved chart to be under level 1 makes it easier to read the numbers Signed-off-by: maryaB-osr <marya@openrobotics.org> * wjwwood review Signed-off-by: maryaB-osr <marya@openrobotics.org> * edits / chart check Signed-off-by: maryaB-osr <marya@openrobotics.org> * fix python incompatibility Signed-off-by: maryaB-osr <marya@openrobotics.org> * mention level 5 in specification intro; fix typos Signed-off-by: William Woodall <william@osrfoundation.org> * Review revisions rep-2004 (#243) Signed-off-by: maryaB-osr <marya@openrobotics.org> * Add item numbers to quality declaration template (#244) * Add item numbers to quality declaration template Signed-off-by: maryaB-osr <marya@openrobotics.org> * list all requirements Signed-off-by: maryaB-osr <marya@openrobotics.org> * link to requirements in chart Signed-off-by: maryaB-osr <marya@openrobotics.org> * fix list indentation Signed-off-by: maryaB-osr <marya@openrobotics.org> * Add security section (#247) Signed-off-by: Kyle Fazzari <kyle@canonical.com> * Update rep-2004.rst Co-Authored-By: Alejandro Hernández Cordero <ahcorde@gmail.com> * Update rep-2004.rst Co-Authored-By: Marya Belanger <marya@openrobotics.org> * Update rep-2004.rst Co-Authored-By: Kyle Fazzari <github@status.e4ward.com> * Adjusting 3.v.b requirement (#253) Signed-off-by: maryaB-osr <marya@openrobotics.org> * Optional chart symbol + "higher quality" distinction * address feedback about copyright statement requirements Signed-off-by: William Woodall <william@osrfoundation.org> Co-authored-by: Marya Belanger <marya@openrobotics.org> Co-authored-by: Kyle Fazzari <github@status.e4ward.com> Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
I like this idea but as I was writing it, it felt a bit odd for a couple of reasons:
Signed-off-by: maryaB-osr marya@openrobotics.org