Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update getting started doc #3576

Merged
merged 1 commit into from
Feb 19, 2019
Merged

Update getting started doc #3576

merged 1 commit into from
Feb 19, 2019

Conversation

klamping
Copy link
Contributor

@klamping klamping commented Feb 19, 2019

Proposed changes

  • Adds requirement to run npm init -y, as the cli config auto-install has trouble otherwise
  • Adds some spacing to help with readability
  • Specifies that you need Firefox installed to use Geckodriver
  • Updates test runner section with a few more details

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Docs

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Reviewers: @webdriverio/technical-committee

- Adds requirement to run `npm init -y`, as the cli config auto-install has trouble otherwise
- Adds some spacing to help with readability
- Specifies that you need Firefox installed to use Geckodriver
- Updates test runner section with a few more details
@codecov
Copy link

codecov bot commented Feb 19, 2019

Codecov Report

Merging #3576 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3576   +/-   ##
=======================================
  Coverage   97.75%   97.75%           
=======================================
  Files         136      136           
  Lines        3024     3024           
  Branches      664      664           
=======================================
  Hits         2956     2956           
  Misses         64       64           
  Partials        4        4

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 420285e...b16cb84. Read the comment docs.

@klamping
Copy link
Contributor Author

On a related note, what do y'all think about replacing the use of geckodriver with chromedriver? Chrome is more likely to be installed (most popular browser out there), and you can use the chromedriver npm package to download/run the binary. Would simplify the first few steps a bit

@pmerwin
Copy link
Contributor

pmerwin commented Feb 19, 2019

I agree, Kevin, I think Chrome makes more sense. @klamping

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

@christian-bromann christian-bromann added the PR: Docs 📝 PRs that contain changes to the documentation label Feb 19, 2019
@christian-bromann christian-bromann merged commit f70abce into master Feb 19, 2019
@christian-bromann christian-bromann deleted the klamping-patch-1 branch February 19, 2019 17:52
yamkay pushed a commit to MoveInc/webdriverio that referenced this pull request Sep 4, 2019
## Proposed changes

[//]: # (Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.)

- Adds requirement to run `npm init -y`, as the cli config auto-install has trouble otherwise
- Adds some spacing to help with readability
- Specifies that you need Firefox installed to use Geckodriver
- Updates test runner section with a few more details


## Types of changes

[//]: # (What types of changes does your code introduce to WebdriverIO?)
[//]: # (_Put an `x` in the boxes that apply_)

- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [x] Docs

## Checklist

[//]: # (_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._)

- [x] I have read the [CONTRIBUTING](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md) doc
- [ ] I have added tests that prove my fix is effective or that my feature works
- [x] I have added necessary documentation (if appropriate)

## Further comments

[//]: # (If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...)

### Reviewers: @webdriverio/technical-committee
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Docs 📝 PRs that contain changes to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants