Automatically use the current year in the copyright notice, show auto…

…mation feature more prominently (#196)
Fraunhofer-AISEC · Aug 13, 2020 · 943ea94 · 943ea94
1 parent f2f4f85
commit 943ea94
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -33,6 +33,39 @@ This project requires Java 11. If Java 11 is not your default Java version, make
 ./gradlew -Dorg.gradle.java.home="/usr/lib/jvm/java-11-openjdk-amd64/" build
 ```
 
+## Copyright Notice
+
+This project has the convention of including a license notice header in all source files:
+```java
+/*
+ * Copyright (c) 2020, Fraunhofer AISEC. All rights reserved.
+ *
+ *  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.
+ *
+ *                    $$$$$$\  $$$$$$$\   $$$$$$\
+ *                   $$  __$$\ $$  __$$\ $$  __$$\
+ *                   $$ /  \__|$$ |  $$ |$$ /  \__|
+ *                   $$ |      $$$$$$$  |$$ |$$$$\
+ *                   $$ |      $$  ____/ $$ |\_$$ |
+ *                   $$ |  $$\ $$ |      $$ |  $$ |
+ *                   \$$$$$   |$$ |      \$$$$$   |
+ *                    \______/ \__|       \______/
+ *
+ */
+```
+If you are using IntelliJ IDEA, you can import `style/copyright.xml` as a copyright profile to automate the header creation process.
+Click [here](https://www.jetbrains.com/help/idea/copyright.html) for further information on copyright profiles.
+
 # Pull Requests
 
 Before we can accept a pull request from you, you'll need to sign a Contributor License Agreement (CLA). It is an automated process and you only need to do it once.

diff --git a/style/copyright.xml b/style/copyright.xml
@@ -26,7 +26,7 @@
 
 <component name="CopyrightManager">
   <copyright>
-    <option name="notice" value="Copyright (c) 2019, Fraunhofer AISEC. All rights reserved.&#10;&#10; Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);&#10; you may not use this file except in compliance with the License.&#10; You may obtain a copy of the License at&#10; &#10;      http://www.apache.org/licenses/LICENSE-2.0&#10;&#10; Unless required by applicable law or agreed to in writing, software&#10; distributed under the License is distributed on an &quot;AS IS&quot; BASIS,&#10; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.&#10; See the License for the specific language governing permissions and&#10; limitations under the License.&#10;&#10;                   &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;\  &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;\   &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;\  &#10;                  &amp;#36;&amp;#36;  __&amp;#36;&amp;#36;\ &amp;#36;&amp;#36;  __&amp;#36;&amp;#36;\ &amp;#36;&amp;#36;  __&amp;#36;&amp;#36;\ &#10;                  &amp;#36;&amp;#36; /  \__|&amp;#36;&amp;#36; |  &amp;#36;&amp;#36; |&amp;#36;&amp;#36; /  \__|&#10;                  &amp;#36;&amp;#36; |      &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;  |&amp;#36;&amp;#36; |&amp;#36;&amp;#36;&amp;#36;&amp;#36;\ &#10;                  &amp;#36;&amp;#36; |      &amp;#36;&amp;#36;  ____/ &amp;#36;&amp;#36; |\_&amp;#36;&amp;#36; |&#10;                  &amp;#36;&amp;#36; |  &amp;#36;&amp;#36;\ &amp;#36;&amp;#36; |      &amp;#36;&amp;#36; |  &amp;#36;&amp;#36; |&#10;                  \&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;   |&amp;#36;&amp;#36; |      \&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;   |&#10;                   \______/ \__|       \______/ &#10;" />
+    <option name="notice" value="Copyright (c) &amp;#36;today.year, Fraunhofer AISEC. All rights reserved.&#10;&#10; Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);&#10; you may not use this file except in compliance with the License.&#10; You may obtain a copy of the License at&#10; &#10;      http://www.apache.org/licenses/LICENSE-2.0&#10;&#10; Unless required by applicable law or agreed to in writing, software&#10; distributed under the License is distributed on an &quot;AS IS&quot; BASIS,&#10; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.&#10; See the License for the specific language governing permissions and&#10; limitations under the License.&#10;&#10;                   &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;\  &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;\   &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;\  &#10;                  &amp;#36;&amp;#36;  __&amp;#36;&amp;#36;\ &amp;#36;&amp;#36;  __&amp;#36;&amp;#36;\ &amp;#36;&amp;#36;  __&amp;#36;&amp;#36;\ &#10;                  &amp;#36;&amp;#36; /  \__|&amp;#36;&amp;#36; |  &amp;#36;&amp;#36; |&amp;#36;&amp;#36; /  \__|&#10;                  &amp;#36;&amp;#36; |      &amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;  |&amp;#36;&amp;#36; |&amp;#36;&amp;#36;&amp;#36;&amp;#36;\ &#10;                  &amp;#36;&amp;#36; |      &amp;#36;&amp;#36;  ____/ &amp;#36;&amp;#36; |\_&amp;#36;&amp;#36; |&#10;                  &amp;#36;&amp;#36; |  &amp;#36;&amp;#36;\ &amp;#36;&amp;#36; |      &amp;#36;&amp;#36; |  &amp;#36;&amp;#36; |&#10;                  \&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;   |&amp;#36;&amp;#36; |      \&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;&amp;#36;   |&#10;                   \______/ \__|       \______/ &#10;" />
     <option name="myName" value="CPG" />
   </copyright>
 </component>