Skip to content

Commit 49127be

Browse files
committed
Added information and rules for contributors
1 parent 3bc3409 commit 49127be

File tree

3 files changed

+39
-15
lines changed

3 files changed

+39
-15
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ This project versioning adheres to [Semantic Versioning](http://semver.org/).
33

44
## Unreleased
55
- Added CHANGELOG.md
6+
- Added CONTRIBUTING.md with information and rules for contributors
67

78
## 1.1.1 - 2015-12-31
89
- Fixed strict standards error in `ChromeDriver`

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to php-webdriver
2+
3+
We love to have your help to make php-webdriver better!
4+
5+
Feel free to open an [issue](https://github.com/facebook/php-webdriver/issues) if you run into any problem, or
6+
send a pull request (see bellow) with your contribution.
7+
8+
## Workflow when contributing a patch
9+
10+
1. Fork the project on GitHub
11+
2. Implement your code changes into separate branch
12+
3. Make sure all PHPUnit tests passes (see below). We also have Travis CI build which will automatically run tests on your pull request).
13+
4. When implementing notable change, fix or a new feature, add record to Unreleased section of [CHANGELOG.md](CHANGELOG.md)
14+
5. Submit your [pull request](https://github.com/facebook/php-webdriver/pulls) against community branch
15+
16+
Note before any pull request can be accepted, a [Contributors Licensing Agreement](http://developers.facebook.com/opensource/cla) must be signed.
17+
18+
When you are going to contribute, please keep in mind that this webdriver client aims to be as close as possible to other languages Java/Ruby/Python/C#.
19+
FYI, here is the overview of [the official Java API](http://selenium.googlecode.com/svn/trunk/docs/api/java/index.html?overview-summary.html)
20+
21+
### Run unit tests
22+
23+
There are two test-suites: one with unit tests only, second with functional tests, which require running selenium server.
24+
25+
To execute all tests simply run:
26+
27+
./vendor/bin/phpunit
28+
29+
If you want to execute just the unit tests, run:
30+
31+
./vendor/bin/phpunit --testsuite Unit-Testsuite
32+
33+
For the functional tests you must first download and start the selenium server, then run the `Functional-Testsuite` test suite:
34+
35+
java -jar selenium-server-standalone-2.48.2.jar -log selenium.log &
36+
./vendor/bin/phpunit --testsuite Functional-Testsuite

README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,18 +92,5 @@ If you're reading this you've already found our Github repository. If you have a
9292
9393
## Contributing
9494
95-
We love to have your help to make php-webdriver better. Feel free to
96-
97-
* open an [issue](https://github.com/facebook/php-webdriver/issues) if you run into any problem.
98-
* fork the project and submit [pull request](https://github.com/facebook/php-webdriver/pulls). Before the pull requests can be accepted, a [Contributors Licensing Agreement](http://developers.facebook.com/opensource/cla) must be signed.
99-
100-
When you are going to contribute, please keep in mind that this webdriver client aims to be as close as possible to other languages Java/Ruby/Python/C#.
101-
FYI, here is the overview of [the official Java API](http://selenium.googlecode.com/svn/trunk/docs/api/java/index.html?overview-summary.html)
102-
103-
### Run unit tests
104-
105-
To run unit tests simply run:
106-
107-
./vendor/bin/phpunit -c ./tests
108-
109-
Note: For the functional test suite, a running selenium server is required.
95+
We love to have your help to make php-webdriver better. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information
96+
about contributing and developing php-webdriver.

0 commit comments

Comments
 (0)