add contributor bootstrap + doc

Author: tanner0101

Package.swift

@@ -23,7 +23,7 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-nio.git", from: "1.0.0"),
     ],
     targets: [
-        .target(name: "PostgreSQL", dependencies: ["Async", "Bits", "Crypto", "DatabaseKit", "NIO", "Service"]),
-        .testTarget(name: "PostgreSQLTests", dependencies: ["PostgreSQL"]),
+        .target(name: "PostgreSQL", dependencies: ["Async", "Bits", "Core", "Crypto", "DatabaseKit", "NIO", "Service"]),
+        .testTarget(name: "PostgreSQLTests", dependencies: ["Core", "PostgreSQL"]),
     ]
 )

Tests/PostgreSQLTests/PostgreSQLConnectionTests.swift

@@ -2,6 +2,7 @@ import Async
 import Foundation
 import XCTest
 import PostgreSQL
+import Core
 
 class PostgreSQLConnectionTests: XCTestCase {
     func testVersion() throws {
@@ -356,11 +357,17 @@ class PostgreSQLConnectionTests: XCTestCase {
 extension PostgreSQLConnection {
     /// Creates a test event loop and psql client.
     static func makeTest() throws -> PostgreSQLConnection {
+        let hostname: String
+        #if TEST_DOCKER_HOSTNAME
+        hostname = try Process.execute("docker-machine", "ip")
+        #else
+        hostname = "localhost"
+        #endif
         let group = MultiThreadedEventLoopGroup(numThreads: 1)
-        let client = try PostgreSQLConnection.connect(on: group) { error in
+        let client = try PostgreSQLConnection.connect(hostname: hostname, on: group) { error in
             XCTFail("\(error)")
         }.wait()
-        _ = try client.authenticate(username: "vapor_username", database: "vapor_database", password: "vapor_password").wait()
+        _ = try client.authenticate(username: "vapor_username", database: "vapor_database", password: nil).wait()
         return client
     }
 }

contribute_bootstrap.sh

@@ -0,0 +1,18 @@
+echo "💧  starting docker..."
+docker-machine start default
+
+echo "💧  exporting docker machine environment..."
+eval $(docker-machine env default)
+
+echo "💧  cleaning previous vapor-psql dev db..."
+docker stop vapor-psql
+docker rm vapor-psql
+
+echo "💧  creating vapor-psql dev db..."
+docker run --name vapor-psql -e POSTGRES_USER=vapor_username -e POSTGRES_DB=vapor_database -p 5432:5432 -d postgres:latest
+
+echo "💧  generating xcode proj..."
+swift package -Xswiftc -DTEST_DOCKER_HOSTNAME generate-xcodeproj
+
+echo "💧  opening xcode..."
+open *.xcodeproj

contributing.md

@@ -0,0 +1,38 @@
+# Contributing to PostgreSQL
+
+👋 Welcome to the Vapor team! 
+
+## Bootstrap
+
+To prepare your computer for developing this package, you can run the bootstrap script.
+
+```sh
+./contribute_boostrap.sh
+```
+
+This script will start up a PostgreSQL docker container to test against. It will also generate and open Xcode for you.
+
+Be careful to observe the script's output, it may have errors or ask you to do additional steps manually.
+
+## Testing
+
+Once in Xcode, select the `PostgreSQL-Package` scheme and use `CMD+U` to run the tests.
+
+When adding new tests (please do 😁), don't forget to add the method name to the `allTests` array. 
+If you add a new `XCTestCase` subclass, make sure to add it to the `Tests/LinuxMain.swift` file.
+
+If you are fixing a single GitHub issue in particular, you can add a test named `testGH<issue number>` to ensure
+that your fix is working. This will also help prevent regression.
+
+## SemVer
+
+Vapor follows [SemVer](https://semver.org). This means that any changes to the source code that can cause
+existing code to stop compiling _must_ wait until the next major version to be included. 
+
+Code that is only additive and will not break any existing code can be included in the next minor release.
+
+----------
+
+Join us on Slack if you have any questions: [http://vapor.team](http://vapor.team).
+
+&mdash; Thanks! 🙌