<div><div dir="auto">About your items:</div></div><div dir="auto">- not sure about module headers. But yeah, @doc in every module is a good guideline</div><div dir="auto">- no idea what you mean by this. I've never seen a -configure line in an Erlang module</div><div dir="auto">- just for exported ones I would say</div><div><br><div class="gmail_quote"><div dir="ltr">On Mon, 29 Oct 2018 at 19:27 <<a href="mailto:lloyd@writersglen.com">lloyd@writersglen.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><font face="arial" size="2"><p style="margin:0;padding:0;font-family:arial;font-size:10pt">Hi All,</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">Terrific list, Brujo!</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">Mind if I pare it down for Erlang and add a few very fundamental items that experienced Erlang programmers take for granted, but newcomers may miss:</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">--  Nicely formatted module header (Is there a convention? Thoughts welcome)</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">--  Uncomment -exort(xxx and and comment -configure(xxx lines</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">-- @doc and -spec documentation of functions (Just exported or all in module?)</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">-- Anything else we're missing?</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">Among other things, how should versions be handled in module headers given that we have an application version and perhaps a mix of module versions?</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">Roger and <span><a title="essen@ninenines.eu">Loïc</a></span>:</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">I couldn't agree with you more about specific statement of what the code does and who it would benefit. And <span><a title="essen@ninenines.eu">Loïc</a></span>'s other tips are well taken.</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">I'll try to work them all in and send updated checklist anon.</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">Thanks,</p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">Lloyd</p></font><font face="arial" size="2">
<p style="margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;font-family:arial;font-size:10pt">-----Original Message-----<br>From: "Brujo Benavides" <<a href="mailto:elbrujohalcon@gmail.com" target="_blank">elbrujohalcon@gmail.com</a>><br>Sent: Monday, October 29, 2018 8:04am<br>To: <a href="mailto:lloyd@writersglen.com" target="_blank">lloyd@writersglen.com</a><br>Cc: "<a href="mailto:erlang-questions@erlang.org" target="_blank">erlang-questions@erlang.org</a>" <<a href="mailto:erlang-questions@erlang.org" target="_blank">erlang-questions@erlang.org</a>><br>Subject: Re: [erlang-questions] Erlang checklists<br><br></p>
<div id="m_-5954185585784481187SafeStyles1540851221">Hi Lloyd,
<div>This is the checklist we have at Inaka: <a href="https://github.com/inaka/guidelines/blob/master/OPEN-SOURCE.md" target="_blank">https://github.com/inaka/guidelines/blob/master/OPEN-SOURCE.md</a></div>
<div>Cheers!<br>
<div>
<div style="color:#000000;font-family:'Trebuchet MS';font-size:14px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px">
<div><span><span><span style="font-size:11pt;font-family:Arial;font-weight:bold;font-variant-ligatures:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-variant-east-asian:normal;vertical-align:baseline;white-space:pre-wrap"><br class="m_-5954185585784481187Apple-interchange-newline"></span></span></span><hr>
<div><strong><em><a href="http://about.me/elbrujohalcon" target="_blank">Brujo Benavides</a></em></strong></div>
</div>
</div>
<div style="color:#000000;font-family:'Trebuchet MS';font-size:14px;font-style:normal;font-variant-caps:normal;font-weight:normal;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px"><strong> </strong></div>
</div>
<div><br>
<blockquote>
<div>On 28 Oct 2018, at 19:39, <a href="mailto:lloyd@writersglen.com" target="_blank">lloyd@writersglen.com</a> wrote:</div>
<br class="m_-5954185585784481187Apple-interchange-newline">
<div>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">Hello,</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">With the generous help of Frank Muller, I recently created the erlPress_core repository on GitHub.</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">Make a few blunders along the way. Still feel shaky about my responsibilities for nurturing the repository.</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">So I'd like to create and share a step_by_step checklist for other Erlang noobs preparing to share code on GitHub with the Erlang community.</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">Please send my your ideas.</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">I'd like to do the same for releasing Erlang applications into production, but I'll hold on that for another time.</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">Many thanks,</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">LRP</div>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<p style="margin:0;padding:0;margin:0;padding:0;font-family:arial;font-size:10pt"> </p>
<div style="margin:0px;padding:0px;font-family:arial;font-size:10pt">*********************************************<br>My books:<br><br>THE GOSPEL OF ASHES<br><a href="http://thegospelofashes.com" target="_blank">http://thegospelofashes.com</a><br><br>Strength is not enough. Do they have the courage <br>and the cunning? Can they survive long enough to <br>save the lives of millions? <br><br>FREEIN' PANCHO<br><a href="http://freeinpancho.com" target="_blank">http://freeinpancho.com</a><br><br>A community of misfits help a troubled boy find his way <br><br>AYA TAKEO<br><a href="http://ayatakeo.com" target="_blank">http://ayatakeo.com</a><br><br>Star-crossed love, war and power in an alternative <br>universe<br><br>Available through Amazon or by request from your <br>favorite bookstore<br><br><br>**********************************************</div>
_______________________________________________<br>erlang-questions mailing list<br><a href="mailto:erlang-questions@erlang.org" target="_blank">erlang-questions@erlang.org</a><br><a href="http://erlang.org/mailman/listinfo/erlang-questions" target="_blank">http://erlang.org/mailman/listinfo/erlang-questions</a></div>
</blockquote>
</div>
</div>
</div></font></blockquote></div></div>-- <br><div dir="ltr" class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr">elbrujohalcon @ iPhone</div></div>