This is an automated email from the ASF dual-hosted git repository.
blue pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 8e6c0a9e Docs: Add copyright style and configuring copyright for IDEA
(#95)
8e6c0a9e is described below
commit 8e6c0a9e784784f932345ee65f6d965f1cb1743e
Author: Luning (Lucas) Wang <[email protected]>
AuthorDate: Tue Jul 5 23:27:21 2022 +0800
Docs: Add copyright style and configuring copyright for IDEA (#95)
---
landing-page/content/common/contribute.md | 54 +++++++++++++++++++++++++++++++
1 file changed, 54 insertions(+)
diff --git a/landing-page/content/common/contribute.md
b/landing-page/content/common/contribute.md
index 456f1784..86564243 100644
--- a/landing-page/content/common/contribute.md
+++ b/landing-page/content/common/contribute.md
@@ -83,6 +83,37 @@ Point to
[intellij-java-palantir-style.xml](https://github.com/apache/iceberg/bl
See also the IntelliJ [Code Style
docs](https://www.jetbrains.com/help/idea/copying-code-style-settings.html) and
[Reformat Code
docs](https://www.jetbrains.com/help/idea/reformat-and-rearrange-code.html) for
additional details.
+### Configuring Copyright for IntelliJ IDEA
+
+Every file needs to include the Apache license as a header. This can be
automated in IntelliJ by
+adding a Copyright profile:
+
+1. In the **Settings/Preferences** dialog go to **Editor → Copyright →
Copyright Profiles**.
+2. Add a new profile and name it **Apache**.
+3. Add the following text as the license text:
+
+ ```
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+ ```
+4. Go to **Editor → Copyright** and choose the **Apache** profile as the
default profile for this
+ project.
+5. Click **Apply**.
+
## Iceberg Code Contribution Guidelines
### Style
@@ -93,6 +124,29 @@ documentation site.
For Python, please use the tox command `tox -e format` to apply autoformatting
to the project.
+### Copyright
+
+Each file must include the Apache license information as a header.
+
+```
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+```
+
### Java style guidelines
#### Line breaks
