Merge pull request #1 from digitalocean/mdl-init

*: add authors, contributing, license checks, stub Go source

Author: mdlayher

.travis.yml

@@ -6,9 +6,10 @@ os:
 sudo: required
 before_install:
   - go get github.com/golang/lint/golint
-  - go get honnef.co/go/staticcheck/cmd/staticcheck
+  - go get honnef.co/go/tools/cmd/staticcheck
   - go get -d ./...
 script:
+  - ./scripts/licensecheck.sh
   - go build -tags=gofuzz ./...
   - go vet ./...
   - staticcheck ./...

AUTHORS

@@ -0,0 +1,14 @@
+Maintainer
+----------
+DigitalOcean, Inc
+
+Original Authors
+----------------
+Matt Layher <[email protected]>
+
+Contributors
+------------
+Michael Ben-Ami <[email protected]>
+Tejas Kokje <[email protected]>
+Kei Nohguchi <[email protected]>
+Neal Shrader <[email protected]>

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+Contributing
+============
+
+The `go-openvswitch` project makes use of the [GitHub Flow](https://guides.github.com/introduction/flow/)
+for contributions.
+
+If you'd like to contribute to the project, please
+[open an issue](https://github.com/digitalocean/go-openvswitch/issues/new) or find an
+[existing issue](https://github.com/digitalocean/go-openvswitch/issues) that you'd like
+to take on.  This ensures that efforts are not duplicated, and that a new feature
+aligns with the focus of the rest of the repository.
+
+Once your suggestion has been submitted and discussed, please be sure that your
+code meets the following criteria:
+  - code is completely `gofmt`'d
+  - new features or codepaths have appropriate test coverage
+  - `go test ./...` passes
+  - `go vet ./...` passes
+  - `staticcheck ./...` passes
+  - `golint ./...` returns no warnings, including documentation comment warnings
+
+In addition, if this is your first time contributing to the `go-openvswitch` project,
+add your name and email address to the
+[AUTHORS](https://github.com/digitalocean/go-openvswitch/blob/master/AUTHORS) file
+under the "Contributors" section using the format:
+`First Last <[email protected]>`.
+
+Finally, submit a pull request for review!

ovs/doc.go

@@ -0,0 +1,16 @@
+// Copyright 2017 DigitalOcean.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package ovs is a client library for Open vSwitch which enables programmatic control of the virtual switch.
+package ovs

scripts/license.txt

@@ -0,0 +1,13 @@
+// Copyright 2017 DigitalOcean.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.

scripts/licensecheck.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Verify that the correct license block is present in all Go source
+# files.
+EXPECTED=$(cat ./scripts/license.txt)
+
+# Scan each Go source file for license.
+EXIT=0
+GOFILES=$(find . -name "*.go")
+
+for FILE in $GOFILES; do
+	BLOCK=$(head -n 14 $FILE)
+
+	if [ "$BLOCK" != "$EXPECTED" ]; then
+		echo "file missing license: $FILE"
+		EXIT=1
+	fi
+done
+
+exit $EXIT