From 943ea940edc6474f48b1dfa387449523b97937c7 Mon Sep 17 00:00:00 2001 From: Samuel Hopstock Date: Thu, 13 Aug 2020 17:42:42 +0200 Subject: [PATCH] Automatically use the current year in the copyright notice, show automation feature more prominently (#196) --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ style/copyright.xml | 2 +- 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3690aa72ca..a1c2aacfa5 100644 --- 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 index 8900fe5f30..e982703376 100644 --- a/style/copyright.xml +++ b/style/copyright.xml @@ -26,7 +26,7 @@ - \ No newline at end of file