search

redhat-cop / casl-ansible

Ansible automation for Managing OpenShift Container Platform clusters
Apache License 2.0
120 stars 81 forks source link

Add license headers to all files #169

Open InfoSec812 opened 6 years ago

InfoSec812 commented 6 years ago

For some clients, having license headers in all files significantly improves the ability for them to approve use of the software.

etsauer commented 6 years ago

@InfoSec812 can you show an example of how another open source project does this?

InfoSec812 commented 6 years ago

@etsauer Lots of projects do it. From my experience, everything owned by ASF or Eclipse Foundation REQUIRES this and more specifically you can look at Apache Camel. https://github.com/apache/camel/blob/master/camel-core/src/main/java/org/apache/camel/AfterPropertiesConfigured.java

InfoSec812 commented 6 years ago

Further still, most of the ASF and Eclipse projects I contribute to require that you sign your commits as well.

InfoSec812 commented 6 years ago

I will commit to creating a GIT pre-commit hook which can check for and/or insert license headers where needed. In addition, I will test out that pre-commit hook by creating a PR to add license headers to the current infra-anisble, casl-ansible, and openshift-applier.

InfoSec812 commented 6 years ago

Pre-commit hook instructions are HERE

oybed commented 6 years ago

We discussed this as part of our weekly CASL call last week and agreed that we will not add the license info to every file. However, we will enforce that each role has the necessary format for documentation, including the license info - as seen here: https://github.com/oybed/infra-ansible/tree/dns-rework7/roles/dns#license