Hi all!

Recently, I've been digging through various OSS compliance checkers that 
analyze the code and content of repository to make sure it passes some 
predefined OSS policy. I realized while working on Apache Annotator 
(incubating) that one of these tools in particular could benefit any ASF 
project.

The project is called repolinter by the TODO Group:
https://github.com/todogroup/repolinter

It checks for various things like the existence of a LICENSE file, the proper 
use of header/preamble text in files, and various other things.

I've customized the default configuration file so that repolinter's checks are 
a bit closer to what ASF project repos actually need to do. You can grab the 
config file here:
https://github.com/apache/incubator-annotator/pull/56/files#diff-8e21d68a689b722dca7791aa735b873c

If you put that in an existing project's code, you can `npm install -g 
repolinter`, and `repolinter .` in that projects directory to see the results 
of the output.

What I'm finding already is that most ASF projects I've checked so far are 
using the "general purpose" preamble:
https://www.apache.org/foundation/license-faq.html#Apply-My-Software
And not the ASF focused (required?) one:
https://www.apache.org/legal/src-headers.html#headers

You can read through more of the changes pending on Apache Annotator's 
repository to bring it into (better) compliance:
https://github.com/apache/incubator-annotator/pull/56

I'd be happy to help get this config file added to some official ASF repository 
or wiki space, so that others can benefit from this handy tool. :)

Cheers!
Benjamin


--

http://bigbluehat.com/

http://linkedin.com/in/benjaminyoung

Reply via email to