KEITH Release Checklist

This guide should be consulted whenever one adds a major change to KEITH.

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: ==

=== General ===

(% class="placeholder-inline-tasks" %)Does the LS start in socket mode? (stdin/out not possible to check efficiently)

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

19

20

=== (% class="placeholder-inline-tasks" %)Views(%%) ===

21

22

23

(% class="placeholder-inline-tasks" %)Does the compiler/simulation/diagram/diagram-option/.. view open

24

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

31

32

==== (% class="placeholder-inline-tasks" %)Compiler View(%%) ====

33

34

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

39

(% class="placeholder-inline-tasks" %)Is the progress bar visible during compilation, is there something weird displayed in the progress bar.

40

41

42

==== (% class="placeholder-inline-tasks" %)Simulation View(%%) ====

43

44

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.

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?

52

53

54

==== Diagram View ====

55

56

57

(% class="placeholder-inline-tasks" %)Source code highlighting

58

59

(% class="placeholder-inline-tasks" %)Highlighting of elements

60