Wiki source code of KEITH Release Checklist
Last modified by Richard Kreissig on 2023/09/14 08:44
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | This guide should be consulted whenever one adds a major change to KEITH. |
| 2 | |||
| 3 | This can either be a Theia or Sprotty update, merging with the master (this is hopefully no longer needed in the future), or a major functionality upgrade. | ||
| 4 | |||
| 5 | For checking UI elements you should always use a Chrome or Chromium browser. | ||
| 6 | |||
| 7 | == Check before building a product/merging: == | ||
| 8 | |||
 |
8.1 | 9 | |
| |
5.1 | 10 | === General === |
| 11 | |||
| |
8.1 | 12 | |
| |
5.1 | 13 | (% class="placeholder-inline-tasks" %)Does the LS start in socket mode? (stdin/out not possible to check efficiently) |
| |
1.1 | 14 | |
| 15 | (% class="placeholder-inline-tasks" %)Do all supported languages have syntax highlighting? | ||
| 16 | |||
| 17 | (% class="placeholder-inline-tasks" %)Do language features such as content assist work for the supported languages? (Check at least one from pragmatic and semantic and two from the some language hierarchy) | ||
| 18 | |||
| |
8.1 | 19 | |
| |
5.1 | 20 | === (% class="placeholder-inline-tasks" %)Views(%%) === |
| |
1.1 | 21 | |
| |
8.1 | 22 | |
| |
5.1 | 23 | (% class="placeholder-inline-tasks" %)Does the compiler/simulation/diagram/diagram-option/.. view open |
| |
1.1 | 24 | |
| |
5.1 | 25 | (% class="placeholder-inline-tasks" %)Are keybindings assigned to open/close each view? |
| 26 | |||
| 27 | (% class="placeholder-inline-tasks" %)Check what happens if all views are initially closed before reload? | ||
| 28 | |||
| 29 | (% class="placeholder-inline-tasks" %)Is the welcome page visible if you initially open a workspace? | ||
| 30 | |||
| |
8.1 | 31 | |
| |
5.1 | 32 | ==== (% class="placeholder-inline-tasks" %)Compiler View(%%) ==== |
| 33 | |||
| |
8.1 | 34 | |
| |
1.1 | 35 | (% class="placeholder-inline-tasks" %)Try to compile a model |
| 36 | |||
| 37 | (% class="placeholder-inline-tasks" %)Click on a snapshot and look whether it is displayed in the diagram view | ||
| 38 | |||
| |
5.1 | 39 | (% class="placeholder-inline-tasks" %)Is the progress bar visible during compilation, is there something weird displayed in the progress bar. |
| 40 | |||
| |
8.1 | 41 | |
| |
5.1 | 42 | ==== (% class="placeholder-inline-tasks" %)Simulation View(%%) ==== |
| 43 | |||
| |
8.1 | 44 | |
| |
1.1 | 45 | (% class="placeholder-inline-tasks" %)Simulate a model. Can you step, show input/output, play, pause, stop, ...? |
| 46 | |||
| 47 | (% class="placeholder-inline-tasks" %)Are current states correctly highlighted in the model? | ||
| 48 | |||
| 49 | (% class="placeholder-inline-tasks" %)Are current states correctly highlighted if a snapshot model is simulated? To check this you have to simulate a model that introduces different states in their snapshot model. | ||
| |
7.1 | 50 | |
| 51 | (% class="placeholder-inline-tasks" %)Can a simulation be started by clicking the play icon in the "Compile with Netlist-based Simulation (C)" compile chain? | ||
| |
1.1 | 52 | |
| |
8.1 | 53 | |
| |
5.1 | 54 | ==== Diagram View ==== |
| |
1.1 | 55 | |
| |
8.1 | 56 | |
| |
1.1 | 57 | (% class="placeholder-inline-tasks" %)Source code highlighting |
| 58 | |||
| 59 | (% class="placeholder-inline-tasks" %)Highlighting of elements | ||
| 60 | |||
| 61 | (% class="placeholder-inline-tasks" %)In the future: does diagram interaction still work | ||
| 62 | |||
| 63 | (% class="placeholder-inline-tasks" %)Check collapse/expand | ||
| 64 | |||
| 65 | (% class="placeholder-inline-tasks" %)Check whether clicking on the label "+" expands it nevertheless | ||
| 66 | |||
| |
7.1 | 67 | (% class="placeholder-inline-tasks" %)Check modifiable styles (test with on-edge labels with direction in SCCharts) |
| 68 | |||
| |
1.1 | 69 | (% class="placeholder-inline-tasks" %)... |
| |
5.1 | 70 | |
| 71 | ==== (% class="placeholder-inline-tasks" %)Diagram Option View(%%) ==== | ||
| 72 | |||
| |
8.1 | 73 | |
| |
7.1 | 74 | (% class="placeholder-inline-tasks" %)Do all listed diagram options work? |
| |
1.1 | 75 | |
| |
8.1 | 76 | |
| |
6.1 | 77 | === (% class="placeholder-inline-tasks" %)Diagram Interaction(%%) === |
| 78 | |||
| |
8.1 | 79 | |
| |
6.1 | 80 | (% class="placeholder-inline-tasks" %)Check all directions |
| 81 | |||
| 82 | (% class="placeholder-inline-tasks" %)Check hierarchical graphs | ||
| 83 | |||
| 84 | (% class="placeholder-inline-tasks" %)Check whether ctrl+z works | ||
| 85 | |||
| 86 | (% class="placeholder-inline-tasks" %)Check adding layer only constraint | ||
| 87 | |||
| 88 | (% class="placeholder-inline-tasks" %)Check position only constraint | ||
| 89 | |||
| 90 | (% class="placeholder-inline-tasks" %)Check deleting constraint | ||
| 91 | |||
| 92 | (% class="placeholder-inline-tasks" %)Check different shift modi | ||
| 93 | |||
| |
5.1 | 94 | === (% class="placeholder-inline-tasks" %)OS/Browser compatibility(%%) === |
| 95 | |||
| |
8.1 | 96 | |
| |
5.1 | 97 | Does it run on Linux/Windows/maybe Mac? |
| |
1.1 | 98 | |
| |
5.1 | 99 | Does in run in Chrome/Chromium/Chromium in Electron/Firefox/...? |