MIR - improvement of interleaved RULEs and TODOs #107
Description
This originate from a Matrix thread that you can find here.
Here is an archive of the discussion:
ven. 4 juil. 2025, 10:29:49 - Skia: https://canonical-ubuntu-project.readthedocs-hosted.com/MIR/mir-reporters-template/#mir-reporters-template
Lines 146 to 155, this section is particularly unclear to me. I guess this might be about specific hardware availability, but that also sounds like a drafted section got pushed to production. I'm not stuck on this and will provide something, but I just want to make sure this is on your radar :-)
ven. 4 juil. 2025, 10:44:37 - Christian Ehrhardt: I'm happy to see the addition of line numbers helps in such requests :-)
ven. 4 juil. 2025, 10:45:36 - Christian Ehrhardt: the history is - too many teams added packages and had no way to test it
ven. 4 juil. 2025, 10:45:45 - Christian Ehrhardt: then later on regressions it "ah sorry, impossible"
ven. 4 juil. 2025, 10:45:56 - Christian Ehrhardt: we try to avoid hat by asking how things can be tested
ven. 4 juil. 2025, 10:46:10 - Christian Ehrhardt: the majority will be "A" => does not need special HW
ven. 4 juil. 2025, 10:46:22 - Christian Ehrhardt: which means you can run and test in a VM or container which is ideal
ven. 4 juil. 2025, 10:46:39 - Christian Ehrhardt: But there is software, especially that close to hardware which can be harder to test
ven. 4 juil. 2025, 10:46:55 - Christian Ehrhardt: In the past we only asked for "how else can you test" but got weird and not really useful answers
ven. 4 juil. 2025, 10:47:03 - Christian Ehrhardt: Since then we split up "B" into examples
ven. 4 juil. 2025, 10:47:31 - Christian Ehrhardt: by our strategy to make testflinger the widely usable way to access different machine types that is the most acceptable version
ven. 4 juil. 2025, 10:47:42 - Christian Ehrhardt: and from there it goes on with other cases we've seen and accept
ven. 4 juil. 2025, 10:47:55 - Christian Ehrhardt: You'd leave one of the B1-5 and fill in the TBD element
ven. 4 juil. 2025, 10:48:09 - Christian Ehrhardt: Was that any better as an explanation?
ven. 4 juil. 2025, 10:48:24 - Christian Ehrhardt: If so, provide a PR to the docs that add whatever was missing
ven. 4 juil. 2025, 10:48:36 - Christian Ehrhardt: If not, please continue to ask until we understand what would help you
ven. 4 juil. 2025, 10:48:56 - Christian Ehrhardt: for fairness, I'm soon unable to answer - but the channel is low traffic - so other should see it
ven. 4 juil. 2025, 10:49:26 - Christian Ehrhardt: If they are lazy come to the MIR meeting and point to it please :-)
ven. 4 juil. 2025, 10:53:26 - Skia: Thanks for the detailed explanation. My package is indeed option A, so no problem. I guess I'm just confused about all the different B options because I don't really deal with that type of situation, and lack some context.
Other thing that confused me was the RULE block in the middle of the options. I guess I find it clearer when there is a RULE block, then all the possible options. Maybe a RULE-B block would actually help show that this RULE block is only when option B applies.
ven. 4 juil. 2025, 10:55:00 - Skia: indeed, it seems to be the only case where there is a RULE block in the middle of the various TODO options
ven. 4 juil. 2025, 12:58:13 - Christian Ehrhardt: We started to co-locate them for easier context awareness
ven. 4 juil. 2025, 12:58:29 - Christian Ehrhardt: There are other interleaves in the rationale section
ven. 4 juil. 2025, 12:59:37 - Christian Ehrhardt: Since this is a general pattern the clarifying explanation would go to the 'how to use templates ' page I guess
ven. 4 juil. 2025, 13:00:06 - Christian Ehrhardt: Can you check if that would already have made it clear in regard to rules vs Todo and cases of todo-b1-5?
ven. 4 juil. 2025, 13:03:27 - Skia: "that"?
indeed, the rational section is a bit messy in that regard. I guess my main point, is to be able to more clearly distinguish the different sections, and which RULEs apply to which TODO.
Having RULE interleaved in the middle of TODO and TODO-{A,B} makes it look like a delimiter, when it's not. Maybe that can be solved by having another clear delimiter like a blank line between each block or something?
ven. 4 juil. 2025, 13:15:57 - Christian Ehrhardt: Yeah blank lines and some further ordering might help
ven. 4 juil. 2025, 13:16:44 - Christian Ehrhardt: Could you copy and paste this chat into a GH issue there and tag it with the MIR label?
ven. 4 juil. 2025, 13:17:27 - Skia: absolutely, thanks for the guidance