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

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

Open
aik099 opened this issue Oct 20, 2015 · 9 comments
Open

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

aik099 opened this issue Oct 20, 2015 · 9 comments

Comments

@aik099
Copy link
Member

aik099 commented Oct 20, 2015

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 minkphp/Mink#677 (comment)

@berliner
Copy link
Contributor

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

@aik099
Copy link
Member Author

aik099 commented Jun 13, 2017

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

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

@berliner
Copy link
Contributor

berliner commented Jun 13, 2017

That's what I thought, but it's not working for me. I'll open a new issue (#179)

@aik099
Copy link
Member Author

aik099 commented Jun 13, 2017

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

@stof
Copy link
Member

stof commented Jun 13, 2017

@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)

@aik099
Copy link
Member Author

aik099 commented Jun 13, 2017

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

@stof
Copy link
Member

stof commented Jun 13, 2017

@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)

@aik099
Copy link
Member Author

aik099 commented Jun 13, 2017

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.

@berliner
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants