Hi Lennart,<div><br></div><div>Indeed, why do not we set up piratpad; or we can use our SVN, the same section we have tutorials in - then it will go directly to <a href="http://genabel.r-forge.r-project.org/">http://genabel.r-forge.r-project.org/</a></div>
<div><br></div><div>I think it is important to have guidelines  and I personally will try to follow them as much as I could.</div><div><br></div><div>At the same time, I would like to emphasize that we had the idea that rules and guidelines should be suggestive, so that even if I do not comply 100% I can still make it into the project, and then can improve on the way. See the quote below.</div>
<div><br></div><div>best, Yurii<br><br><div>Quote from</div><div><br></div><div><a href="http://www.genabel.org/developers">http://www.genabel.org/developers</a>:</div><div><br></div><div>Rules of the game</div><div>The documents provided here are meant to help. We are scared to think of a situation when 'guidelines' and 'rules' prevent people from contributing to the project, and a willing contributor is discouraged by just looking at the pile of 'rules'.</div>
<br><div class="gmail_quote">On Mon, Mar 18, 2013 at 9:32 AM, L.C. Karssen <span dir="ltr"><<a href="mailto:lennart@karssen.org" target="_blank">lennart@karssen.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Dear all,<br>
<br>
I'd like to follow up on something Yurii wrote in the discussion on the<br>
GenABEL tutorial:<br>
<br>
On 03/14/2013 09:38 AM, Yurii Aulchenko wrote:<br>
> I agree that full argument names should be preferred. I was just being<br>
> lazy; I am trying to improve. If other people come up with things<br>
> which are "not in good style" we should probably think of a "good<br>
> style rules" document and then ask people to please to follow them.<br>
><br>
<br>
I completely agree with Yurii. In fact, I think we should not only set<br>
guidelines for the style of the code in the tutorial, but more generally<br>
for all R and C/C++ code in the GenABEL project.<br>
<br>
What about setting up a shared editing environment (e.g. on<br>
<a href="http://piratepad.net" target="_blank">piratepad.net</a>) to work on an initial draft of these quidelines? Once<br>
they are more or less fixed we can move the document to SVN as part of<br>
the developer documentation.<br>
<br>
>From my experience over the last few years I think the following points<br>
are the most commonly occurring ones (for any language) that need<br>
harmonisation:<br>
- comma's should be followed by a space<br>
- operators (= + - * etc.) should be surrounded by a space (and in R the<br>
<- operator too)<br>
- a file should always have a newline at the end<br>
- don't use tabs (as everyone seems to have a different setting for the<br>
tab stop): use spaces. How many spaces is up for debate. Of course<br>
Makefiles are exempt from this rule as tabs are mandatory<br>
- style of brackets: is the opening bracket on the same line as the name<br>
of the loop/function or on a new line on its own? (e.g. K&R, Allman or<br>
bsd style)<br>
- always use {} in if clauses/for loops (even if there is only one<br>
statement in the clause/loop<br>
- lines should not be longer than 80 characters (you may call me old<br>
fashioned ;-))<br>
<br>
I think most of these can be set as options in modern development<br>
environment. I'm not an Eclipse user, like many of you, but in Emacs<br>
these can easily be set in your .emacs file. We should also provide info<br>
on how to implement these settings in various DEs in our guidelines<br>
document so that new developers can easily use them.<br>
<br>
<br>
Lennart.<br>
<span class="HOEnZb"><font color="#888888">--<br>
-----------------------------------------------------------------<br>
L.C. Karssen<br>
Utrecht<br>
The Netherlands<br>
<br>
<a href="mailto:lennart@karssen.org">lennart@karssen.org</a><br>
<a href="http://blog.karssen.org" target="_blank">http://blog.karssen.org</a><br>
<br>
Stuur mij aub geen Word of Powerpoint bestanden!<br>
Zie <a href="http://www.gnu.org/philosophy/no-word-attachments.nl.html" target="_blank">http://www.gnu.org/philosophy/no-word-attachments.nl.html</a><br>
------------------------------------------------------------------<br>
<br>
</font></span><br>_______________________________________________<br>
genabel-devel mailing list<br>
<a href="mailto:genabel-devel@lists.r-forge.r-project.org">genabel-devel@lists.r-forge.r-project.org</a><br>
<a href="https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/genabel-devel" target="_blank">https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/genabel-devel</a><br></blockquote></div><br><br clear="all">
<div><br></div>-- <br>-----------------------------------------------------<br>Yurii S. Aulchenko<br><div><br></div><div>[ <a href="http://nl.linkedin.com/in/yuriiaulchenko" target="_blank">LinkedIn</a> ] [ <a href="http://twitter.com/YuriiAulchenko" target="_blank">Twitter</a> ] [ <a href="http://yurii-aulchenko.blogspot.nl/" target="_blank">Blog</a> ]</div>

</div>