HughP / simal

Automatically exported from code.google.com/p/simal
0 stars 0 forks source link

Document purpose and use of RAT for new developers #372

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
I spent a bit of time dealing with the confusing message "too many unapproved 
licenses" when doing a build to which I had added new files (in truth, copied 
existing files). I ended up removing RAT from the pom.xml. 

To reduce the learning curve for new developers, it's possibly worth mentioning 
as a step in the Getting Started: disabling RAT. Or explaining how to work with 
it or something.

Original issue reported on code.google.com by Stevage on 19 Jan 2011 at 11:50

GoogleCodeExporter commented 9 years ago
I agree it should be mentioned in more clearly in the docs, although there 
shouldn't be any files without licence headers. Unless you are adding your own 
files that is.

I'm not keen on encouraging people to disable it. It is there for a very good 
reason, if we encourage folk to disable it then we are encouraging bad practice 
that we will have to resolve before being able to accept patches.

On a more general note, please don't "spend a bit of time" trying to figure 
confusing stuff out. Feel free to ask as soon as you hit an issue. 

It might be that we don't address it for a short while and you are no better 
off, but I often find the act of describing what it happening and why it is a 
problem helps focus the mind on a solution. It also provides useful information 
in our archives/issue trackers. Finally, since you are such a good open source 
citizen and submitting issues it's not adding any extra work for any of us, 
hopefully it's reducing those times where you are blocked by something we have 
done.

Original comment by ross.gardler on 19 Jan 2011 at 11:59

GoogleCodeExporter commented 9 years ago
This issue was closed by revision r2117.

Original comment by ross.gardler on 20 Jan 2011 at 12:13

GoogleCodeExporter commented 9 years ago
>although there shouldn't be any files without licence headers. Unless you are 
adding your own files that is.

What I did was simply duplicate the whole doapcreator tree, calling it 
ands-doapcreator. But because the method I used for building after this change 
(inside the eclipse workspace) was different to how I had built in the previous 
method, I can't be certain that that was the sole cause of the problem.

>It is there for a very good reason

I guess there's a tradeoff between producing good releases and making it easy 
for developers to explore, play, build, hack... Totally your call, of course.

>On a more general note, please don't "spend a bit of time" trying to figure 
confusing stuff out. Feel free to ask as soon as you hit an issue. 

With the timezone difference, it's not always practical to down tools 
immediately and ask for help, but I greatly appreciate the willingness to help.

Original comment by Stevage on 20 Jan 2011 at 6:56