enhanced CONTRIBUTING.md and ajdjusted license headers in all files

Signed-off-by: Thomas Jaeckle <[email protected]>
bosch-io · Mar 28, 2019 · c3817ec · c3817ec
1 parent 5041c8c
commit c3817ec
Show file tree

Hide file tree

Showing 59 changed files with 642 additions and 315 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -48,6 +48,51 @@ The only adjustment: use longer lines ("line split") with 120 characters instead
 * Make sure you use the `-s` flag when committing as explained above
 * Push your changes to your branch in your forked repository
 
+## License header
+
+Please make sure any file you newly create contains a proper license header. Find the latest one in use here:
+[legal/license-header.txt](legal/license-header.txt)
+
+Adjusted for Java classes:
+```java
+/*
+ * Copyright (c) 2019 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+```
+
+Adjusted for XML files:
+```xml
+<!--
+  ~ Copyright (c) 2019 Contributors to the Eclipse Foundation
+  ~
+  ~ See the NOTICE file(s) distributed with this work for additional
+  ~ information regarding copyright ownership.
+  ~
+  ~ This program and the accompanying materials are made available under the
+  ~ terms of the Eclipse Public License 2.0 which is available at
+  ~ http://www.eclipse.org/legal/epl-2.0
+  ~
+  ~ SPDX-License-Identifier: EPL-2.0
+  -->
+```
+
+### Important
+
+Please do not forget to add your name/organization to the [legal/NOTICE.md](legal/NOTICE.md) file's Copyright Holders 
+section. If this is not the first contribution you make, then simply update the time period contained in the copyright
+entry to use the year of your first contribution as the lower boundary and the current year as the upper boundary, e.g.
+
+    Copyright 2018-2019 ACME Corporation
+
 ## Submitting the Changes
 
 Submit a pull request via the normal GitHub UI.

diff --git a/grove-ctrl/python/ditto_grove_demo.py b/grove-ctrl/python/ditto_grove_demo.py
@@ -1,20 +1,22 @@
 #!/usr/bin/python3
-# Copyright (c) 2017 Bosch Software Innovations GmbH.
+# Copyright (c) 2017 Contributors to the Eclipse Foundation
 #
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Eclipse Public License v2.0
-# which accompanies this distribution, and is available at
-# https://www.eclipse.org/org/documents/epl-2.0/index.php
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
 #
-# Contributors:
-#    Bosch Software Innovations GmbH - initial contribution
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0
+#
+# SPDX-License-Identifier: EPL-2.0
 
 
-import raspberry_thing
-import websocket
-import time
 import json
 import math
+import time
+import websocket
+
+import raspberry_thing
 
 DITTO_IP = "localhost"
 DITTO_PORT = "8000"

diff --git a/grove-ctrl/python/grove_buzzer.py b/grove-ctrl/python/grove_buzzer.py
@@ -1,12 +1,13 @@
-# Copyright (c) 2017 Bosch Software Innovations GmbH.
+# Copyright (c) 2017 Contributors to the Eclipse Foundation
 #
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Eclipse Public License v2.0
-# which accompanies this distribution, and is available at
-# https://www.eclipse.org/org/documents/epl-2.0/index.php
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
 #
-# Contributors:
-#    Bosch Software Innovations GmbH - initial contribution
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0
+#
+# SPDX-License-Identifier: EPL-2.0
 import grovepi
 
 

diff --git a/grove-ctrl/python/grove_light_sensor.py b/grove-ctrl/python/grove_light_sensor.py
@@ -1,12 +1,13 @@
-# Copyright (c) 2017 Bosch Software Innovations GmbH.
+# Copyright (c) 2017 Contributors to the Eclipse Foundation
 #
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Eclipse Public License v2.0
-# which accompanies this distribution, and is available at
-# https://www.eclipse.org/org/documents/epl-2.0/index.php
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
 #
-# Contributors:
-#    Bosch Software Innovations GmbH - initial contribution
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0
+#
+# SPDX-License-Identifier: EPL-2.0
 
 import grovepi
 from datetime import datetime

diff --git a/grove-ctrl/python/grove_temp_sensor.py b/grove-ctrl/python/grove_temp_sensor.py
@@ -1,12 +1,13 @@
-# Copyright (c) 2017 Bosch Software Innovations GmbH.
+# Copyright (c) 2017 Contributors to the Eclipse Foundation
 #
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Eclipse Public License v2.0
-# which accompanies this distribution, and is available at
-# https://www.eclipse.org/org/documents/epl-2.0/index.php
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
 #
-# Contributors:
-#    Bosch Software Innovations GmbH - initial contribution
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0
+#
+# SPDX-License-Identifier: EPL-2.0
 
 import grovepi
 from datetime import datetime

diff --git a/grove-ctrl/python/grovepi_mock.py b/grove-ctrl/python/grovepi_mock.py
@@ -1,12 +1,13 @@
-# Copyright (c) 2017 Bosch Software Innovations GmbH.
+# Copyright (c) 2017 Contributors to the Eclipse Foundation
 #
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Eclipse Public License v2.0
-# which accompanies this distribution, and is available at
-# https://www.eclipse.org/org/documents/epl-2.0/index.php
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
 #
-# Contributors:
-#    Bosch Software Innovations GmbH - initial contribution
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0
+#
+# SPDX-License-Identifier: EPL-2.0
 
 analogReadIndex = 0
 analogReadValues = [130.12, 113199.13, 939992.3, 57.5]

diff --git a/grove-ctrl/python/raspberry_thing.py b/grove-ctrl/python/raspberry_thing.py
@@ -1,17 +1,19 @@
-# Copyright (c) 2017 Bosch Software Innovations GmbH.
+# Copyright (c) 2017 Contributors to the Eclipse Foundation
 #
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Eclipse Public License v2.0
-# which accompanies this distribution, and is available at
-# https://www.eclipse.org/org/documents/epl-2.0/index.php
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
 #
-# Contributors:
-#    Bosch Software Innovations GmbH - initial contribution
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0
+#
+# SPDX-License-Identifier: EPL-2.0
 
 # To 'mock' the calls to grovepi script, change this line to 'import grovepi_mock as grovepi'
 import base64
-import time
 import threading
+import time
+
 from grove_buzzer import Buzzer
 from grove_light_sensor import LightSensor
 from grove_temp_sensor import TemperatureHumiditySensor

diff --git a/grove-ctrl/webapp/index.html b/grove-ctrl/webapp/index.html
@@ -1,20 +1,21 @@
+<!--
+  ~ Copyright (c) 2017 Contributors to the Eclipse Foundation
+  ~
+  ~ See the NOTICE file(s) distributed with this work for additional
+  ~ information regarding copyright ownership.
+  ~
+  ~ This program and the accompanying materials are made available under the
+  ~ terms of the Eclipse Public License 2.0 which is available at
+  ~ http://www.eclipse.org/legal/epl-2.0
+  ~
+  ~ SPDX-License-Identifier: EPL-2.0
+  -->
 <!DOCTYPE html>
 <html lang="en">
 
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <!--
-    Copyright (c) 2017 Bosch Software Innovations GmbH.
-
-    All rights reserved. This program and the accompanying materials
-    are made available under the terms of the Eclipse Public License v2.0
-    which accompanies this distribution, and is available at
-    https://www.eclipse.org/org/documents/epl-2.0/index.php
-
-    Contributors:
-    Bosch Software Innovations GmbH - initial contribution
-    -->
     <link rel="stylesheet" href="node_modules/bootstrap/dist/css/bootstrap.min.css">
     <link rel="stylesheet" href="node_modules/font-awesome/css/font-awesome.min.css">
 </head>
@@ -220,4 +221,4 @@ <h5 class="modal-title" id="configureModalLabel">Configuration</h5>
     <script src="index.js"></script>
 </body>
 
-</html>
+</html>
diff --git a/grove-ctrl/webapp/index.js b/grove-ctrl/webapp/index.js
@@ -1,14 +1,15 @@
 /*
-    Copyright (c) 2017 Bosch Software Innovations GmbH.
-
-    All rights reserved. This program and the accompanying materials
-    are made available under the terms of the Eclipse Public License v2.0
-    which accompanies this distribution, and is available at
-    https://www.eclipse.org/org/documents/epl-2.0/index.php
-
-    Contributors:
-    Bosch Software Innovations GmbH - initial contribution
-*/
+ * Copyright (c) 2017 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 
 class App {
     constructor(baseUrl = 'http://localhost:8080', username = 'ditto', password = 'ditto') {

diff --git a/legal/NOTICE.md b/legal/NOTICE.md
@@ -0,0 +1,38 @@
+This content is produced and maintained by the Eclipse Ditto project.
+
+* Project home: https://www.eclipse.org/ditto
+
+# Trademarks
+
+* Eclipse Ditto and the Eclipse Ditto project logo are trademarks of the Eclipse Foundation.
+* Eclipse and the Eclipse logo are registered trademarks of The Eclipse Foundation.
+* Java and all Java-based trademarks are trademarks of Oracle Corporation in the United States, other countries, or both.
+
+# Declared Project Licenses
+
+This program and the accompanying materials are made available under the terms
+of the Eclipse Public License 2.0 which is available at https://www.eclipse.org/legal/epl-2.0/.
+
+SPDX-License-Identifier: EPL-2.0
+
+# Source Code
+
+* https://github.com/eclipse/ditto-examples
+
+# Copyright holders
+
+* Copyright 2017-2019 Bosch Software Innovations GmbH
+* Copyright 2019 Microsoft Corp.
+
+All content is the property of the respective authors or their employers.
+For more information regarding authorship of content, please consult the
+listed source code repository logs.
+
+# Cryptography
+
+Content may contain encryption software. The country in which you are currently
+may have restrictions on the import, possession, and use, and/or re-export to
+another country, of encryption software. BEFORE using any encryption software,
+please check the country's laws, regulations and policies concerning the import,
+possession, or use, and re-export of encryption software, to see if this is
+permitted.
diff --git a/legal/license-header-2017.txt b/legal/license-header-2017.txt
@@ -0,0 +1,10 @@
+Copyright (c) 2017 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License 2.0 which is available at
+http://www.eclipse.org/legal/epl-2.0
+
+SPDX-License-Identifier: EPL-2.0
diff --git a/legal/license-header-2018.txt b/legal/license-header-2018.txt
@@ -0,0 +1,10 @@
+Copyright (c) 2018 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License 2.0 which is available at
+http://www.eclipse.org/legal/epl-2.0
+
+SPDX-License-Identifier: EPL-2.0
diff --git a/legal/license-header.txt b/legal/license-header.txt
@@ -0,0 +1,10 @@
+Copyright (c) 2019 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License 2.0 which is available at
+http://www.eclipse.org/legal/epl-2.0
+
+SPDX-License-Identifier: EPL-2.0
diff --git a/mqtt-bidirectional/iot-device/octopus/src/main.ino b/mqtt-bidirectional/iot-device/octopus/src/main.ino
@@ -1,3 +1,15 @@
+/*
+ * Copyright (c) 2017 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 #include <Wire.h>
 #include "ESP8266WiFi.h"
 #include <Adafruit_Sensor.h>

diff --git a/mqtt-bidirectional/iot-frontend/babel.config.js b/mqtt-bidirectional/iot-frontend/babel.config.js
@@ -1,3 +1,15 @@
+/*
+ * Copyright (c) 2017 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 module.exports = {
   presets: [
     '@vue/app'

diff --git a/mqtt-bidirectional/iot-frontend/public/index.html b/mqtt-bidirectional/iot-frontend/public/index.html
@@ -1,3 +1,15 @@
+<!--
+  ~ Copyright (c) 2017 Contributors to the Eclipse Foundation
+  ~
+  ~ See the NOTICE file(s) distributed with this work for additional
+  ~ information regarding copyright ownership.
+  ~
+  ~ This program and the accompanying materials are made available under the
+  ~ terms of the Eclipse Public License 2.0 which is available at
+  ~ http://www.eclipse.org/legal/epl-2.0
+  ~
+  ~ SPDX-License-Identifier: EPL-2.0
+  -->
 <!DOCTYPE html>
 <html lang="en">
   <head>