You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+9-14
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Go over the steps in [this](https://github.com/firstcontributions/first-contribu
7
7
To start you need:
8
8
9
9
1. Fork and clone the repo.
10
-
2. Run `npm install --legacy-peer-deps` to install all required libraries
10
+
2. Run `npm install --legacy-peer-deps --omit=optional` to install all required libraries
11
11
3. Do the changes.
12
12
4. Add/Update Test (if possible)
13
13
5. Update documentation
@@ -28,7 +28,7 @@ node bin/codecept.js run -c examples
28
28
```
29
29
30
30
31
-
Depending on a type of a change you should do the following.
31
+
Depending on a type of change you should do the following.
32
32
33
33
## Debugging
34
34
@@ -100,7 +100,7 @@ Edit a test at `test/rest/REST_test.js` or `test/rest/ApiDataFactory_test.js`
100
100
101
101
It is recommended to run mobile tests on CI.
102
102
So do the changes, make pull request, see the CI status.
103
-
Appium tests are executed at **Semaphore CI**.
103
+
Appium tests are executed at **Saucelabs**.
104
104
105
105
## Core Changes
106
106
@@ -109,7 +109,7 @@ Please try to add corresponding testcase to runner or unit.
109
109
110
110
## Documentation
111
111
112
-
Documentation is stored in `/docs` directory in markdown format.
112
+
Documentation is stored in `/docs` directory in Markdown format.
113
113
114
114
**Documentation for helpers is a part of a source code**.
115
115
@@ -121,7 +121,7 @@ After you updated docblock in JS file, generate markdown files with next command
121
121
npm run docs
122
122
```
123
123
124
-
Documentation parts can be shared accross helpers. Those parts are located in `docs/webapi/*.mustache`. Inside a docblock those files can be included like this:
124
+
Documentation parts can be shared across helpers. Those parts are located in `docs/webapi/*.mustache`. Inside a docblock those files can be included like this:
125
125
126
126
```js
127
127
/**
@@ -134,7 +134,7 @@ Documentation parts can be shared accross helpers. Those parts are located in `d
134
134
135
135
## Typings
136
136
137
-
Typings is generated in `typings/` directory via `jsdoc`
137
+
Typings are generated in `typings/` directory via `jsdoc`
138
138
139
139
After you updated docblock in JS file, generate typing files with next command:
140
140
@@ -163,7 +163,7 @@ mocha test/runner
163
163
Instead of manually running php, json_server and selenium for before tests you
164
164
can use `docker-compose` to run those automatically.
165
165
You can find `docker-compose.yml` file in `test` directory and run all commands
166
-
from this directory. Currently we provide following commands to run tests with
166
+
from this directory. Currently, we provide following commands to run tests with
167
167
respective dependencies:
168
168
169
169
#### Run unit tests
@@ -186,12 +186,7 @@ docker-compose run --rm test-helpers test/rest
186
186
```
187
187
188
188
#### Run acceptance tests
189
-
190
-
<<<<<<< HEAD
191
-
To that we provide three separate services respectively for WebDriver, Puppeteer tests:
192
-
=======
193
189
To that we provide three separate services respectively for WebDriver, Nightmare and Puppeteer tests:
194
-
>>>>>>> 3.x
195
190
196
191
```sh
197
192
docker-compose run --rm test-acceptance.webdriverio
@@ -200,7 +195,7 @@ docker-compose run --rm test-acceptance.puppeteer
200
195
201
196
#### Running against specific Node version
202
197
203
-
By default dockerized tests are run against node 12.10.0, you can run it against
198
+
By default, dockerized tests are run against node 12.10.0, you can run it against
204
199
specific version as long as there is Docker container available for such
205
200
version. To do that you need to build codecept's Docker image prior to running
206
201
tests and pass `NODE_VERSION` as build argument.
@@ -215,7 +210,7 @@ And now every command based on `test-helpers` service will use node 9.4.0. The
215
210
same argument can be passed when building unit and acceptance tests services.
216
211
217
212
### CI flow
218
-
We're currently using bunch of CI services to build and test codecept in
213
+
We're currently using a bunch of CI services to build and test codecept in
219
214
different environments. Here's short summary of what are differences between
0 commit comments