[GitHub] houshengbo closed pull request #115: Document the header rule

[GitBox <gi...@apache.org>]

houshengbo closed pull request #115: Document the header rule
URL: https://github.com/apache/incubator-openwhisk-release/pull/115
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/license_compliance.md b/docs/license_compliance.md
index 44872cb..3a6dbe4 100644
--- a/docs/license_compliance.md
+++ b/docs/license_compliance.md
@@ -36,6 +36,22 @@ In OpenWhisk project, we will exclude below type of files from license header ve
 
 In OpenWhisk project, we decided to apply short form of header to minified OpenWhisk action source files in order to get better performance.
 
+| File type | Included or Excluded | Header type | Justifications |
+| --- | --- | --- | --- |
+| Documentation (`*.md`) | Included | Full Apache license header | |
+| YAML files (`*.yaml`, `*.yml`) | Included | Full Apache license header | |
+| Docker file (`dockerfile`) | Included | Full Apache license header | |
+| Installation script files (`*.sh`) | Included | Full Apache license header | |
+| Travis files (`*.sh`) | Included | Full Apache license header | |
+| Makefile | Included | Full Apache license header | |
+| Test data files | Included | Short Apache license header | <ul><li>Is it intellectual property? YES</li><li>Does it impact performance? YES (NOTE: these tests MAY be used for perf. testing, but mostly for unit/function testing)</li><li>Will it break Travis builds? MAYBE (we can address this later if needed)</li></ul>|
+| Action files in catalog | Included | Short Apache license header | with much creativity so need IP protection; also need to take care of the performance |
+| Gradle files | Excluded | - | Not much creativity |
+| IDE configuration files | Excluded | - | Not much creativity |
+| Template files (`*.j2`) | Excluded | - | Not much creativity |
+| Json files (`*.json`) | Excluded | - | Json files don't support comments officially |
+| `i18n_resources.go` | Excluded | - | Not much creativity. The file is auto created. Not able to add header |
+
 ## Tools and scripts
 
 [verify_source_code.sh](../tools/verify_source_code.sh) in the `tools` folder is to verify license compliance. [Apache Rat](https://creadur.apache.org/rat/) is used to verify license headers. Files excluded license header verification following the previous rules are configured in the file [pom.xml](../tools/travis/pom.xml).


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services