Skip to content

Commit 89ede9a

Browse files
seanbuddseanbudd
authored
Merge 890a70e into d8396f9 
2 parents d8396f9 + 890a70e commit 89ede9a

4 files changed

Lines changed: 92 additions & 81 deletions

File tree

‎devDocs/githubPullRequestTemplateExplanationAndExamples.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,12 @@ Discuss under "testing strategy" heading:
151151
- Describe the coverage of automated system tests?
152152
- Is the changed code already, or can it be covered by automated system tests?
153153
- Manual tests
154+
- Have you followed any relevant test plans in [the manual test documentation](../tests/manual/README.md)?
154155
- How did you manually test the change?
155-
- Be clear on steps another user can take to replicate your testing.
156-
- Is the described manual testing appropriate for the change?
157-
- Clearly describing this helps alpha testers, and future developers.
156+
- Be clear on steps another user can take to replicate your testing.
157+
- Clearly describing this helps alpha testers, and future developers.
158+
- Is this a commonly tested part of NVDA?
159+
If so, please add your manual test steps to [the manual test documentation](../tests/manual/README.md).
158160
- As a reviewer, please use this description to replicate the testing (if possible).
159161

160162
### API is compatible with existing add-ons.

‎devDocs/startupShutdown.md‎

Lines changed: 1 addition & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -33,84 +33,7 @@
3333
1. Windows shutting down (terminates unsafely) (uses `wx.EVT_END_SESSION`)
3434

3535
## Manual testing
36-
Instructions for testing startup / shutdown.
37-
38-
### Start from shortcut
39-
Prerequisites:
40-
- NVDA installed
41-
- Shortcut enabled during installation
42-
43-
Steps:
44-
1. Press (or emulate) Ctrl+Alt+N, observe NVDA starts up
45-
46-
Variation:
47-
- At step 1. A version of NVDA is already running. Observe running version exits before installed version starts up.
48-
49-
### Windows Sign-in screen, automatic start
50-
Prerequisites:
51-
- NVDA installed
52-
- Enable "Use NVDA during sign-in"
53-
54-
Steps:
55-
1. Sign out (not lock) Windows
56-
1. Observe NVDA announces the Windows sign-in screen
57-
58-
### UAC, automatic start
59-
Prerequisites:
60-
- NVDA installed
61-
- An active Windows session (i.e. not signed out, locked)
62-
- The NVDA installed copy is running
63-
64-
Steps:
65-
1. Open the Start menu
66-
1. Type notepad
67-
1. Open context menu for notepad and choose `Run as Administrator`.
68-
1. When the UAC dialog appears, verify that NVDA launches on this secure desktop and reports the dialog.
69-
70-
### Windows Successful sign-in, automatic start
71-
Prerequisites:
72-
- NVDA installed
73-
- Enable "Start NVDA after I sign in"
74-
75-
Steps:
76-
1. Start Windows
77-
1. Sign in
78-
1. Observe NVDA starts
79-
80-
### Running the *.exe
81-
82-
Steps:
83-
1. Press `win+r`
84-
1. Enter <path to nvda.exe>
85-
1. Press enter
86-
1. Observe NVDA starts
87-
88-
Variation:
89-
- using an installer (launcher)
90-
- eg: `C:\Users\username\Downloads\nvda_2021.1.exe`
91-
- using an installed copy
92-
- just type `nvda` in place of the .exe
93-
- using a portable copy
94-
- find and use the path to `nvda.exe`, located within the portable copy directory
95-
- the installer allows you to create an installed copy and a portable copy
96-
97-
### Running from source (runnvda.bat)
98-
Prerequisites
99-
- clone project and build NVDA (see [project readme](https://github.com/nvaccess/nvda/blob/master/readme.md#getting-the-source-code)).
100-
101-
Steps:
102-
1. Run `runnvda.bat` from cmd
103-
1. Observe NVDA starts
104-
105-
### An input gesture to restart
106-
107-
Prerequisite:
108-
- Input gesture for "Restarts NVDA!" is assigned
109-
110-
Steps:
111-
1. Press (or emulate) the input gesture
112-
1. Observe that NVDA exits
113-
1. Observe that a new instance is started
36+
Check the [manual test guide](../tests/manual/startupShutdown.md).
11437

11538
## Technical notes
11639

‎tests/manual/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Manual testing
2+
3+
Commonly tested components of NVDA should have standard test plans.
4+
5+
This directory contains markdown files group by the NVDA component, e.g. "addon store", "start up / shutdown", "speech dictionaries", "settings", etc.
6+
7+
The goal is to document manual test plans for commonly tested NVDA components.
8+
This gives contributors a base test plan when creating PRs that touch these NVDA components.

‎tests/manual/startupShutdown.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
Instructions for testing startup / shutdown.
2+
3+
### Start from shortcut
4+
Prerequisites:
5+
- NVDA installed
6+
- Shortcut enabled during installation
7+
8+
Steps:
9+
1. Press (or emulate) Ctrl+Alt+N, observe NVDA starts up
10+
11+
Variation:
12+
- At step 1. A version of NVDA is already running. Observe running version exits before installed version starts up.
13+
14+
### Windows Sign-in screen, automatic start
15+
Prerequisites:
16+
- NVDA installed
17+
- Enable "Use NVDA during sign-in"
18+
19+
Steps:
20+
1. Sign out (not lock) Windows
21+
1. Observe NVDA announces the Windows sign-in screen
22+
23+
### UAC, automatic start
24+
Prerequisites:
25+
- NVDA installed
26+
- An active Windows session (i.e. not signed out, locked)
27+
- The NVDA installed copy is running
28+
29+
Steps:
30+
1. Open the Start menu
31+
1. Type notepad
32+
1. Open context menu for notepad and choose `Run as Administrator`.
33+
1. When the UAC dialog appears, verify that NVDA launches on this secure desktop and reports the dialog.
34+
35+
### Windows Successful sign-in, automatic start
36+
Prerequisites:
37+
- NVDA installed
38+
- Enable "Start NVDA after I sign in"
39+
40+
Steps:
41+
1. Start Windows
42+
1. Sign in
43+
1. Observe NVDA starts
44+
45+
### Running the *.exe
46+
47+
Steps:
48+
1. Press `win+r`
49+
1. Enter <path to nvda.exe>
50+
1. Press enter
51+
1. Observe NVDA starts
52+
53+
Variation:
54+
- using an installer (launcher)
55+
- eg: `C:\Users\username\Downloads\nvda_2021.1.exe`
56+
- using an installed copy
57+
- just type `nvda` in place of the .exe
58+
- using a portable copy
59+
- find and use the path to `nvda.exe`, located within the portable copy directory
60+
- the installer allows you to create an installed copy and a portable copy
61+
62+
### Running from source (runnvda.bat)
63+
Prerequisites
64+
- clone project and build NVDA (see [project readme](https://github.com/nvaccess/nvda/blob/master/readme.md#getting-the-source-code)).
65+
66+
Steps:
67+
1. Run `runnvda.bat` from cmd
68+
1. Observe NVDA starts
69+
70+
### An input gesture to restart
71+
72+
Prerequisite:
73+
- Input gesture for "Restarts NVDA!" is assigned
74+
75+
Steps:
76+
1. Press (or emulate) the input gesture
77+
1. Observe that NVDA exits
78+
1. Observe that a new instance is started

0 commit comments

Comments
 (0)