Skip to content

Commit b5d9f2f

Browse files
authored
Merge pull request #2008 from PeterNgTr/fix-template
update minor things in templates
2 parents 339c588 + 5ac6d77 commit b5d9f2f

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To start you need:
88
2. Run `npm install` to install all required libraries
99
3. Do the changes.
1010
4. Add/Update Test (if possible)
11-
5. Update documentation
11+
5. Update documentation
1212
6. Commit and Push to your fork
1313
7. Make Pull Request
1414

@@ -20,7 +20,6 @@ node bin/codecept.js
2020

2121
To run examples:
2222

23-
2423
```
2524
node bin/codecept.js run -c examples
2625
```
@@ -30,9 +29,9 @@ Depending on a type of a change you should do the following.
3029

3130
## Helpers
3231

33-
Please keep in mind that CodeceptJS have **unified API** for WebDriverIO, Appium, Protractor, SeleniumWebdriver, Nightmare. Tests written using those helpers should be compatible at syntax level. However, some of helpers may contain unique methods. That happen. If, for instance, WebDriverIO have method XXX and SeleniumWebDriver doesn't, you can implement XXX inside SeleniumWebDriver using the same method signature.
32+
Please keep in mind that CodeceptJS have **unified API** for WebDriverIO, Appium, Protractor, Nightmare, Puppeteer, TestCafe. Tests written using those helpers should be compatible at syntax level. However, some of helpers may contain unique methods. That happens. If, for instance, WebDriverIO has method XXX and Nightmare doesn't, you can implement XXX inside Nightmare using the same method signature.
3433

35-
### Updating a WebDriverIO | SeleniumWebdriver | Nightmare
34+
### Updating a WebDriverIO | Nightmare
3635

3736
*Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required! Do **not edit** `docs/helpers/`, those files are generated from docblocks in corresponding helpers! *
3837

@@ -75,7 +74,7 @@ http://localhost:8000/form/myexample
7574

7675
*Whenever a new method or new behavior is added it should be documented in a docblock. Valid JS-example is required! Do **not edit** `docs/helpers/`, those files are generated from docblocks in corresponding helpers! *
7776

78-
Protractor Helper extends SeleniumWebdriver. For non-protractor specific changes you will need to update SeleniumWebdriver helper instead. See section above.
77+
Protractor helper is based on [Protractor library](http://www.protractortest.org)
7978

8079
In case you do Protractor-specific change, please add a test:To run the test suite you need:
8180

@@ -191,7 +190,7 @@ docker-compose run --rm test-acceptance.protractor
191190

192191
#### Running against specific Node version
193192

194-
By default dockerized tests are run against node 8.9.1, you can run it against
193+
By default dockerized tests are run against node 12.10.0, you can run it against
195194
specific version as long as there is Docker container available for such
196195
version. To do that you need to build codecept's Docker image prior to running
197196
tests and pass `NODE_VERSION` as build argument.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
Applicable helpers:
44

5-
[ ] Webdriver
6-
[ ] Puppeteer
7-
[ ] Nightmare
8-
[ ] REST
9-
[ ] Appium
10-
[ ] Protractor
11-
[ ] TestCafe
5+
- [ ] Webdriver
6+
- [ ] Puppeteer
7+
- [ ] Nightmare
8+
- [ ] REST
9+
- [ ] Appium
10+
- [ ] Protractor
11+
- [ ] TestCafe
1212

1313
- Description of this PR, which problem it solves
1414
- A link to the corresponding issue (if applicable).
1515

1616
## Type of change
1717

1818
- [ ] Breaking changes
19-
- [ ] New functionnality
19+
- [ ] New functionality
2020
- [ ] Bug fix
21-
- [ ] Documentation change/update
21+
- [ ] Documentation changes/updates
2222
- [ ] Hot fix
2323
- [ ] Markdown files fix - not related to source code
2424

0 commit comments

Comments
 (0)