[erlang-questions] Erlang checklists

[Dmytro Lytovchenko]

With all that is mentioned by Brujo before, ...

Think about your future new user. Some empathy (i have empatic character,
and i know this first hand you see).


   - What are your new user's first steps when he opened your library's web
   page?
   - Will he see a description? (many libraries have really bad
   descriptions) Some welcoming examples and a quick start?
   - What will he take as his first *hello_your_library*? And maybe some
   advanced examples too?
   - Where will he come to read the docs?
   - (bonus points) A community discussion board or something like that?
   Issues page on Github that is well maintained is a good first step.


On Mon, 29 Oct 2018 at 22:28, <lloyd@REDACTED> wrote:

> Hi All,
>
>
>
> Terrific list, Brujo!
>
>
>
> 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:
>
>
>
> --  Nicely formatted module header (Is there a convention? Thoughts
> welcome)
>
> --  Uncomment -exort(xxx and and comment -configure(xxx lines
>
> -- @doc and -spec documentation of functions (Just exported or all in
> module?)
>
> -- Anything else we're missing?
>
>
>
> 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?
>
>
>
> Roger and Loïc:
>
>
>
> I couldn't agree with you more about specific statement of what the code
> does and who it would benefit. And Loïc's other tips are well taken.
>
>
>
> I'll try to work them all in and send updated checklist anon.
>
>
>
> Thanks,
>
>
>
> Lloyd
>
>
>
> -----Original Message-----
> From: "Brujo Benavides" <elbrujohalcon@REDACTED>
> Sent: Monday, October 29, 2018 8:04am
> To: lloyd@REDACTED
> Cc: "erlang-questions@REDACTED" <erlang-questions@REDACTED>
> Subject: Re: [erlang-questions] Erlang checklists
>
> Hi Lloyd,
> This is the checklist we have at Inaka:
> https://github.com/inaka/guidelines/blob/master/OPEN-SOURCE.md
> Cheers!
>
> ------------------------------
> *Brujo Benavides <http://about.me/elbrujohalcon>*
>
>
> On 28 Oct 2018, at 19:39, lloyd@REDACTED wrote:
>
> Hello,
>
>
> With the generous help of Frank Muller, I recently created the
> erlPress_core repository on GitHub.
>
>
> Make a few blunders along the way. Still feel shaky about my
> responsibilities for nurturing the repository.
>
>
> 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.
>
>
> Please send my your ideas.
>
>
> I'd like to do the same for releasing Erlang applications into production,
> but I'll hold on that for another time.
>
>
> Many thanks,
>
>
> LRP
>
>
>
>
> *********************************************
> My books:
>
> THE GOSPEL OF ASHES
> http://thegospelofashes.com
>
> Strength is not enough. Do they have the courage
> and the cunning? Can they survive long enough to
> save the lives of millions?
>
> FREEIN' PANCHO
> http://freeinpancho.com
>
> A community of misfits help a troubled boy find his way
>
> AYA TAKEO
> http://ayatakeo.com
>
> Star-crossed love, war and power in an alternative
> universe
>
> Available through Amazon or by request from your
> favorite bookstore
>
>
> **********************************************
> _______________________________________________
> erlang-questions mailing list
> erlang-questions@REDACTED
> http://erlang.org/mailman/listinfo/erlang-questions
>
> _______________________________________________
> erlang-questions mailing list
> erlang-questions@REDACTED
> http://erlang.org/mailman/listinfo/erlang-questions
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20181029/5085cec9/attachment.htm>