Skip to content

Commit a80440f

Browse files
committed
add end game test plan item templates read me
1 parent 005725b commit a80440f

1 file changed

Lines changed: 125 additions & 0 deletions

File tree

endgame/README.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
## Test Plan Items
2+
3+
A test plan item should specify its complexity from 1 till 5 and should have the platforms in which it has to be tested against. You can pre-assign them to a user you would like to test by adding his/her user id next to platform. If there are more than one authors for it, all the authors should be specified. Test plan item description should contain all these details. Following are the examples:
4+
5+
### Platforms
6+
7+
- macOS
8+
- windows
9+
- linux
10+
- wsl
11+
- ssh
12+
- dev container
13+
- anyOS
14+
15+
### Example 1 (Platforms)
16+
17+
```markdown
18+
19+
Refs: <!-- Refer to the issue that this test plan item is testing. -->
20+
21+
- [ ] macOS
22+
- [ ] linux
23+
- [ ] windows
24+
25+
Complexity: 2
26+
27+
---
28+
29+
<!-- Please write your test here. -->
30+
31+
```
32+
33+
### Example 2 (Any platforms)
34+
35+
```markdown
36+
37+
Refs: <!-- Refer to the issue that this test plan item is testing. -->
38+
39+
- [ ] anyOS
40+
- [ ] anyOS
41+
42+
Complexity: 4
43+
44+
---
45+
46+
<!-- Please write your test here. -->
47+
48+
```
49+
50+
### Example 3 (One specific and other any platform)
51+
52+
```markdown
53+
54+
Refs: <!-- Refer to the issue that this test plan item is testing. -->
55+
56+
- [ ] windows
57+
- [ ] anyOS
58+
59+
Complexity: 4
60+
61+
---
62+
63+
<!-- Please write your test here. -->
64+
65+
```
66+
67+
### Example 4 (Pre-assigned)
68+
69+
```markdown
70+
71+
Refs: <!-- Refer to the issue that this test plan item is testing. -->
72+
73+
- [ ] macOS: @user1
74+
- [ ] linux
75+
76+
Complexity: 4
77+
78+
Authors: @user1, @user2
79+
80+
---
81+
82+
<!-- Please write your test here. -->
83+
84+
```
85+
86+
### Example 5 (Remote)
87+
88+
```markdown
89+
90+
Refs: <!-- Refer to the issue that this test plan item is testing. -->
91+
92+
- [ ] wsl
93+
- [ ] ssh
94+
- [ ] dev container
95+
96+
Complexity: 2
97+
98+
---
99+
100+
<!-- Please write your test here. -->
101+
102+
```
103+
104+
### Example 6 (Multiple Authors)
105+
106+
```markdown
107+
108+
Refs: <!-- Refer to the issue that this test plan item is testing. -->
109+
110+
- [ ] windows
111+
- [ ] linux
112+
113+
Complexity: 4
114+
115+
Authors: @user1, @user2
116+
117+
---
118+
119+
<!-- Please write your test here. -->
120+
121+
```
122+
123+
## Platform assignments
124+
125+
[Platforms](./platforms.json) has the list users and the platforms in which they can test. First platform is considered as primary platform. Please update this when there are changes.

0 commit comments

Comments
 (0)