You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by Otto Fowler <ot...@gmail.com> on 2016/12/21 20:45:12 UTC

Apache Lic on README.md files?

I was just looking at the NiFi source, and noticed that they include the
license header in their readme files.  Is this something that we are
supposed to be doing or is it optional?

Re: Apache Lic on README.md files?

Posted by Joey Frazee <jo...@icloud.com>.
Since markdown is intended to be rendered when read and is rendered on GitHub I think it's also important to include the short license text not in a comment.

On a related note I think it's frowned upon to have as many wildcarded rat check excludes as are currently there in the pom. It's a hassle but it's safer to do the excludes per file in the sub-modules.

-joey

> On Dec 21, 2016, at 4:18 PM, Otto Fowler <ot...@gmail.com> wrote:
> 
> Looks like they use XML escapes <!—  —>
> 
> 
> 
> On December 21, 2016 at 15:48:07, Casey Stella (cestella@gmail.com) wrote:
> 
> We should do this. I was not aware that Markdown took comments. Every
> file which is capable of handling comments should have an apache license,
> IIRC.
> 
> On Wed, Dec 21, 2016 at 3:45 PM, Otto Fowler <ot...@gmail.com>
> wrote:
> 
>> I was just looking at the NiFi source, and noticed that they include the
>> license header in their readme files. Is this something that we are
>> supposed to be doing or is it optional?
>> 

Re: Apache Lic on README.md files?

Posted by Otto Fowler <ot...@gmail.com>.
Looks like they use XML escapes <!—  —>



On December 21, 2016 at 15:48:07, Casey Stella (cestella@gmail.com) wrote:

We should do this. I was not aware that Markdown took comments. Every
file which is capable of handling comments should have an apache license,
IIRC.

On Wed, Dec 21, 2016 at 3:45 PM, Otto Fowler <ot...@gmail.com>
wrote:

> I was just looking at the NiFi source, and noticed that they include the
> license header in their readme files. Is this something that we are
> supposed to be doing or is it optional?
>

Re: Apache Lic on README.md files?

Posted by Casey Stella <ce...@gmail.com>.
We should do this.  I was not aware that Markdown took comments.  Every
file which is capable of handling comments should have an apache license,
IIRC.

On Wed, Dec 21, 2016 at 3:45 PM, Otto Fowler <ot...@gmail.com>
wrote:

> I was just looking at the NiFi source, and noticed that they include the
> license header in their readme files.  Is this something that we are
> supposed to be doing or is it optional?
>