MinkZombieDriver icon indicating copy to clipboard operation
MinkZombieDriver copied to clipboard

Write step-by-step "Contributor Getting Started" guide

Open aik099 opened this issue 10 years ago • 9 comments

Drivers have very basic instructions on how to get use them, but no instructions how to contribute into them. Need to add section on CONTRIBUTING.md with details about:

  • how to install (e.g. download from there, use Composer here, use npm here)
  • how to add tests
  • how to run tests

See https://github.com/minkphp/Mink/pull/677#issuecomment-147461807

aik099 avatar Oct 20 '15 18:10 aik099

I second that. Currently I'm struggling with making the MinkZombieDriver tests tun in order to create a PR. Documentation would be greatly appreciated.

berliner avatar Jun 13 '17 11:06 berliner

That one is easy, because you only need to have:

  • zombie installed (the npm -g install zombie)
  • phpunit installed
  • run phpunit

aik099 avatar Jun 13 '17 12:06 aik099

That's what I thought, but it's not working for me. I'll open a new issue (https://github.com/minkphp/MinkZombieDriver/issues/179)

berliner avatar Jun 13 '17 12:06 berliner

Is there any error message, that you're seeing?

aik099 avatar Jun 13 '17 13:06 aik099

@aik099 npm install zombie even works, no need for a global install (it is even easier, as you don't need to put an extra env variable pointing to the global module).

and you forgot the command running the fixtures server: ./vendor/bin/mink-test-server (this is a long-running command)

stof avatar Jun 13 '17 13:06 stof

I thought that driver starts server automatically as it always did.

aik099 avatar Jun 13 '17 13:06 aik099

@aik099 you are confusing the zombie server process (started automatically) and the webserver hosting fixtures of the driver testsuite (never started automatically. We relied on using Apache in older versions of the driver, before adding the script based on php -S)

stof avatar Jun 13 '17 13:06 stof

the webserver hosting fixtures of the driver testsuite

I see. I've never used it because I have web server running locally anyway and in phpunit.xml specified fixture location in there.

aik099 avatar Jun 13 '17 13:06 aik099

@aik099, @stof I actually had the fixtures server running as that was indicated in the README, just forgot to mention it in #179.

berliner avatar Jun 13 '17 13:06 berliner