Several documentation improvements

* Bump phantomjs Linux installation links to 2.1.1

* Add a note discouraging Ubuntu phantomjs packages

* Tweak contributing docs to include [ci skip]

[ci skip]
This commit is contained in:
David Rodríguez 2017-05-06 11:29:25 -03:00
parent 6eb71de2fc
commit 049951954a
2 changed files with 13 additions and 5 deletions

View File

@ -16,20 +16,24 @@ as well as the steps you've taken to isolate the issue so far.
# Add a Feature; fix a Bug # Add a Feature; fix a Bug
All pull requests must contain
[good commit messages](https://github.com/blog/926-shiny-new-commit-styles).
All pull requests which add a feature or fix a bug must have the All pull requests which add a feature or fix a bug must have the
following things: following extra things:
* Integration test(s). These generally go into * Integration test(s). These generally go into
`spec/integration/session_spec.rb`, unless it's something specific to `spec/integration/session_spec.rb`, unless it's something specific to
the driver, in which case it goes in `spec/integration/driver_spec.rb`. the driver, in which case it goes in `spec/integration/driver_spec.rb`.
(So a test for `page.driver.resize` goes in `driver_spec.rb` but a test (So a test for `page.driver.resize` goes in `driver_spec.rb` but a test
for `page.execute_script` goes in `session_spec.rb`.) for `page.execute_script` goes in `session_spec.rb`.)
* A [good commit
message](https://github.com/blog/926-shiny-new-commit-styles)
* An entry into the changelog. Reference the Github issue number if there is an * An entry into the changelog. Reference the Github issue number if there is an
associated bug report. Feel free to add your name if you want to be associated bug report. Feel free to add your name if you want to be
credited. credited.
Documentation-only pull requests must include [ci skip] in their commit
messages.
# Keep in mind: # Keep in mind:
* While PhantomJS is capable of compiling and running CoffeeScript code * While PhantomJS is capable of compiling and running CoffeeScript code

View File

@ -53,11 +53,15 @@ dependencies* (you don't need Qt, or a running X server, etc.)
### Linux ### ### Linux ###
* Download the [32 bit](https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.8-linux-i686.tar.bz2) * Download the [32 bit](https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-i686.tar.bz2)
or [64 bit](https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.8-linux-x86_64.tar.bz2) or [64 bit](https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-x86_64.tar.bz2)
binary. binary.
* Extract the tarball and copy `bin/phantomjs` into your `PATH` * Extract the tarball and copy `bin/phantomjs` into your `PATH`
_DO NOT_ use `phantomjs` from the official Ubuntu repositories, since it doesn't
work well with `poltergeist`. More information
[here](https://github.com/teampoltergeist/poltergeist/issues/866).
### Windows ### ### Windows ###
* Download the [precompiled binary](https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.8-windows.zip) * Download the [precompiled binary](https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.8-windows.zip)
for Windows for Windows