Merge pull request #152 from sbalabanov/master

Make project fully compatible to FB opensource standards

CODE_OF_CONDUCT.md

@@ -0,0 +1,5 @@
+# Code of Conduct
+
+Facebook has adopted a Code of Conduct that we expect project participants to adhere to.
+Please read the [full text](https://code.fb.com/codeofconduct/)
+so that you can understand what actions will and will not be tolerated.

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to Nailgun
+
+We encourage the reporting of issues and bugs, along with pull requests to help make Nailgun codebase better. The following are some information and guidelines to help you contribute to Nailgun.
+
+## Tour of the Codebase
+
+This is a high-level overview of how the Nailgun repository is organized.
+
+### `nailgun-server/`
+
+That is where server side code lives, written in Java. It contains both core code under `src/main` and test code under `src/tests`.
+
+### `nailgun-client/`
+
+Client part of Nailgun, both C and Python versions in appropriate folders.
+
+### `nailgun-examples/`
+
+Some simple implementations of a Nail, helpful to understand how to write server-side code. One can also execute one of those nails for debugging or integration testing.
+
+### `scripts/`
+
+Automation scripts, mostly for continuous integration (i.e. Travis CI).
+
+### `tools/`
+
+Third-party dependencies used in tooling, like linter or code formatter.
+
+## Development Workflow
+
+### Building Nailgun
+
+As simple as running `mvn clean package`.
+
+### Running Tests
+
+Unit tests and integration tests are JUnit and they are run by Maven when you say 'mvn package'. To run E2E test, just execute `./scripts/travis_ci.sh`. It will also run `mvn package` first with all unit tests.
+
+### Using the IntelliJ IDE
+
+Just open project from Nailgun's root folder
+
+### Code Style
+
+Code is autoformatted with Maven plugin and Google code style is used. Be ready to have some changed files after building the project with Maven, so you may have to amend the change to git.

nailgun-client/py/__init__.py

@@ -1 +1,4 @@
+# Copyright 2004-2015, Martian Software, Inc.
+# Copyright 2017-Present Facebook, Inc.
+
 from ng import NailgunConnection, NailgunException

nailgun-examples/src/main/java/com/facebook/nailgun/examples/Heartbeat.java

@@ -1,5 +1,6 @@
 /*
   Copyright 2004-2012, Jim Purbrick.
+  Copyright 2017-Present Facebook, Inc.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

nailgun-server/src/main/java/com/facebook/nailgun/NGExitException.java

@@ -1,4 +1,7 @@
 /*
+ * Copyright 2004-2012, Martian Software, Inc.
+ * Copyright 2017-Present Facebook, Inc
+ *
  * This class is based upon org.apache.tools.ant.ExitException and is
  * subject to the following:
  *

nailgun-server/src/main/java/com/facebook/nailgun/builtins/NGVersion.java

@@ -1,3 +1,20 @@
+/*
+  Copyright 2004-2012, Martian Software, Inc.
+  Copyright 2017-Present Facebook, Inc.
+
+  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 com.facebook.nailgun.builtins;
 
 import com.facebook.nailgun.NGConstants;

nailgun-server/src/main/resources/com/facebook/nailgun/builtins/builtins.properties

@@ -1,3 +1,19 @@
+#
+# Copyright 2004-2015, Martian Software, Inc.
+# Copyright 2017-Present Facebook, Inc.
+#
+# 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.
+
 ng-alias=com.facebook.nailgun.builtins.NGAlias
 ng-alias.desc=Displays and manages command aliases
 

scripts/travis_run.sh

@@ -1,4 +1,20 @@
 #!/bin/sh
+#
+# Copyright 2004-2015, Martian Software, Inc.
+# Copyright 2017-Present Facebook, Inc.
+#
+# 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.
+
 set -eux
 
 mvn package