Skip to content

Commit 07807c4

Browse files
author
Spencer Rinehart
committed
Update documentation to better match our standard.
1 parent 9ae2cdf commit 07807c4

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,20 @@ Developers may be contacted at:
5353
* [Pull Requests](https://github.com/dominionenterprises/mongo-queue-php/pulls)
5454
* [Issues](https://github.com/dominionenterprises/mongo-queue-php/issues)
5555

56-
##Tests
57-
58-
Install and start [mongodb](http://www.mongodb.org).
59-
With a checkout of the code get [Composer](http://getcomposer.org) in your PATH and run:
56+
##Contributing
57+
58+
If you would like to contribute, please use our build process for any changes
59+
and after the build passes, send us a pull request on github! The build
60+
requires a running mongo. The URI to mongo can be specified via an environment
61+
variable or left to its default (localhost on the default port, 27017):
62+
```sh
63+
TESTING_MONGO_URL=mongodb://127.0.0.1:27017 ./build.php
64+
```
6065

61-
```bash
62-
php build.php
66+
There is also a [docker](http://www.docker.com/)-based
67+
[fig](http://www.fig.sh/) configuration that will standup a docker container
68+
for the database, execute the build inside a docker container, and then
69+
terminate everything. This is an easy way to build the application:
70+
```sh
71+
fig run build
6372
```

0 commit comments

Comments
 (0)