Skip to content

Commit f39c39b

Browse files
committed
fix: update contribution guide
1 parent 73f74bb commit f39c39b

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

.github/CONTRIBUTING.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Go over the steps in [this](https://github.com/firstcontributions/first-contribu
77
To start you need:
88

99
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
1111
3. Do the changes.
1212
4. Add/Update Test (if possible)
1313
5. Update documentation
@@ -28,7 +28,7 @@ node bin/codecept.js run -c examples
2828
```
2929

3030

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.
3232

3333
## Debugging
3434

@@ -100,7 +100,7 @@ Edit a test at `test/rest/REST_test.js` or `test/rest/ApiDataFactory_test.js`
100100

101101
It is recommended to run mobile tests on CI.
102102
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**.
104104

105105
## Core Changes
106106

@@ -109,7 +109,7 @@ Please try to add corresponding testcase to runner or unit.
109109

110110
## Documentation
111111

112-
Documentation is stored in `/docs` directory in markdown format.
112+
Documentation is stored in `/docs` directory in Markdown format.
113113

114114
**Documentation for helpers is a part of a source code**.
115115

@@ -121,7 +121,7 @@ After you updated docblock in JS file, generate markdown files with next command
121121
npm run docs
122122
```
123123

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

126126
```js
127127
/**
@@ -134,7 +134,7 @@ Documentation parts can be shared accross helpers. Those parts are located in `d
134134

135135
## Typings
136136

137-
Typings is generated in `typings/` directory via `jsdoc`
137+
Typings are generated in `typings/` directory via `jsdoc`
138138

139139
After you updated docblock in JS file, generate typing files with next command:
140140

@@ -163,7 +163,7 @@ mocha test/runner
163163
Instead of manually running php, json_server and selenium for before tests you
164164
can use `docker-compose` to run those automatically.
165165
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
167167
respective dependencies:
168168

169169
#### Run unit tests
@@ -186,12 +186,7 @@ docker-compose run --rm test-helpers test/rest
186186
```
187187

188188
#### Run acceptance tests
189-
190-
<<<<<<< HEAD
191-
To that we provide three separate services respectively for WebDriver, Puppeteer tests:
192-
=======
193189
To that we provide three separate services respectively for WebDriver, Nightmare and Puppeteer tests:
194-
>>>>>>> 3.x
195190

196191
```sh
197192
docker-compose run --rm test-acceptance.webdriverio
@@ -200,7 +195,7 @@ docker-compose run --rm test-acceptance.puppeteer
200195

201196
#### Running against specific Node version
202197

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
204199
specific version as long as there is Docker container available for such
205200
version. To do that you need to build codecept's Docker image prior to running
206201
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
215210
same argument can be passed when building unit and acceptance tests services.
216211

217212
### 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
219214
different environments. Here's short summary of what are differences between
220215
separate services
221216

package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,10 @@
106106
"sprintf-js": "1.1.1",
107107
"uuid": "9.0"
108108
},
109+
"optionalDependencies": {
110+
"@codeceptjs/detox-helper": "1.0.2"
111+
},
109112
"devDependencies": {
110-
"@codeceptjs/detox-helper": "1.0.2",
111113
"@codeceptjs/mock-request": "0.3.1",
112114
"@faker-js/faker": "7.6.0",
113115
"@pollyjs/adapter-puppeteer": "6.0.6",

0 commit comments

Comments
 (0)