Repository: kylin Updated Branches: refs/heads/document 7a97d513c -> bf9783975
KYLIN-2019: Doc for header checkstlye Signed-off-by: Li Yang <liy...@apache.org> Project: http://git-wip-us.apache.org/repos/asf/kylin/repo Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/bf978397 Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/bf978397 Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/bf978397 Branch: refs/heads/document Commit: bf9783975c9414d3136252a901011ac0c236808c Parents: 7a97d51 Author: Yiming Liu <liuyiming....@gmail.com> Authored: Thu Sep 29 13:18:48 2016 +0800 Committer: Li Yang <liy...@apache.org> Committed: Tue Oct 11 11:18:01 2016 +0800 ---------------------------------------------------------------------- website/_dev/dev_env.md | 24 +++++++++++++++++++ .../images/develop/intellij_apache_license.png | Bin 0 -> 422164 bytes 2 files changed, 24 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kylin/blob/bf978397/website/_dev/dev_env.md ---------------------------------------------------------------------- diff --git a/website/_dev/dev_env.md b/website/_dev/dev_env.md index 2fbf36e..1147265 100644 --- a/website/_dev/dev_env.md +++ b/website/_dev/dev_env.md @@ -131,3 +131,27 @@ For intellij IDEA users, you have to do a few more steps:  3. Format the code before committing the code. + +## Setup IDE license header template + +Each source file should include the following Apache License header +{% highlight Groff markup %} +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. +{% endhighlight %} + +The checkstyle plugin will check the header rule when packaging also. The license file locates under `dev-support/checkstyle-apache-header.txt`. To make it easy for developers, please add the header as `Copyright Profile` and set it as default for Kylin project. + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/kylin/blob/bf978397/website/images/develop/intellij_apache_license.png ---------------------------------------------------------------------- diff --git a/website/images/develop/intellij_apache_license.png b/website/images/develop/intellij_apache_license.png new file mode 100644 index 0000000..4d86a8d Binary files /dev/null and b/website/images/develop/intellij_apache_license.png differ
