1
- # [ WIP] This guide is being developed.
1
+ # [ WIP] This guide is under development
2
2
3
+ Also see [ Testing] manual.
3
4
5
+ [ Testing ] : Testing.md
4
6
5
7
## Overview
6
8
7
9
### Test frameworks we use and their purpose
8
10
9
11
// Codeception, PHPunit. Structure of tests
10
12
11
- ## Running tests locally
12
-
13
- 1 . Install JDK
14
-
15
- 2 . Install Selenium Web Driver by executing ` download.sh ` which is located in your hipanel dir in ` tests/software/ `
16
-
17
- 3 . Execute ` run.sh ` (in same folder) to run on background
18
-
19
- 4 . To run tests locally use ` codecept ` which is located in your hipanel dir in ` vendor/bin/ `
20
-
21
- More info about how to run tests with codecept [ Here] ( https://codeception.com/docs/02-GettingStarted#Running-Tests )
22
-
23
- ### Running tests inside Docker
24
-
25
- // How to?
26
-
27
-
28
13
## Contributing
29
14
30
- > Before contributing make sure you have last update of your repositories.
15
+ > Before contributing make sure you have last update of your repositories.
31
16
>
32
- > (use ` composer update ` on whole project or ` git pull ` in specific module)
17
+ > (use ` composer update ` on whole project or ` git pull ` in specific module)
33
18
34
19
To contribute follow this steps:
35
20
@@ -41,7 +26,7 @@ To contribute follow this steps:
41
26
42
27
2 . Type ` git remote add [remote name] [url] ` inside your module dir
43
28
44
- ` [remote name] ` is name of your remote branch (for example ` forked ` )
29
+ ` [remote name] ` is name of your remote branch (for example ` forked ` )
45
30
46
31
` [url] ` is your forked url
47
32
@@ -52,7 +37,6 @@ To contribute follow this steps:
52
37
4 . After ` git add ` when you make ` git commit -m [message] ` follow this simple rules:
53
38
54
39
1 . Your ` [message] ` must start with __ one__ word like ` Added ` , ` Changed ` , ` Fixed ` , ` Removed `
55
-
56
40
2 . Next will follow the description of what exactly was added, changed or removed.
57
41
58
42
5 . Next you ` git push [remote name] [branch name] `
@@ -62,17 +46,17 @@ To contribute follow this steps:
62
46
6 . After that you need to create a __ pull request__ .
63
47
64
48
You can do it at github website:
65
-
49
+
66
50
1 . Open repository (for example [ hipnel] ( https://github.com/hiqdev/hipanel ) )
67
-
51
+
68
52
2 . Click __ New pull request__
69
-
53
+
70
54
(or click green __ Compare & pull request__ and skip __ iii__ step)
71
55
72
56
3 . Click __ compare across forks__ and on the right choose __ your forked repository__ -> __ brach name__
73
-
57
+
74
58
4 . Click green __ Create pull request__
75
-
59
+
76
60
7 . After your pull request was reviewed and you have to make some changes,
77
61
all you need to do is just make that changes and ` push ` to the same ` [remote name] [branch name] ` .
78
62
@@ -115,11 +99,3 @@ To make xDebug work in PHPStorm you need:
115
99
// - debug session does not get started;
116
100
// - debug can not locate files;
117
101
118
- #### Contributing to Codeception tests
119
-
120
- // How to run tests and enhance them?
121
-
122
- To limit tests execution scope to a single cest, run codecept
123
- ` ./vendor/bin/codecept ` with arguments ` run ` and ` path to file `
124
- [ Examples] ( https://codeception.com/docs/02-GettingStarted#Running-Tests )
125
-
0 commit comments