Skriptke has asked for the wisdom of the Perl Monks concerning the following question:

I recently uploaded my first module to CPAN. For a beginner like me, is easy to make mistakes.

Maybe the experts can help, if anyone has suggestions for me on:
http://search.cpan.org/dist/Nes/

I'll be very grateful.

Thank you.
  • Comment on My new templating solution: comments please

Replies are listed 'Best First'.
Re: Hello World!
by moritz (Cardinal) on Feb 26, 2010 at 14:04 UTC

    Thank you for contributing to the CPAN.

    There are a few things you could do better:

    • Use Template::Nes instead of just Nes as the namespace (or something similar). I have no idea what Nes means when I read it, which is bad as a top-level namespace. In the Template:: namespace there are already Template::Simple, Template::Alloy etc., so your module would be in good company.
    • Since there's a variety of template modules already on CPAN, you should explain in the documentation what the difference between your system and other systems is, and why one should chose your template system. Do this very early in the documentation
    • Write unit tests for your package. See Test::Tutorial for how to get started.
    • Don't ship files with whitespaces in their names; people often don't like that. It also breaks your MANIFEST.
    • Your LICENSE section is contradictory. You probably wanted to write "under the same terms as Perl itself"
    Perl 6 - links to (nearly) everything that is Perl 6.
        Thank
      Nes: No Embedded Source

      documentation is only in Spanish: nes.sourceforge.net for the moment, explains some aspects of its response.

      consults the issue of file spaces: perl.module-authors

      the license is GPL, but anyone can include it under the Perl license, my English is very bad, you may be poorly explained.

      Thank you very much.
Re: Hello World!
by eyepopslikeamosquito (Archbishop) on Feb 26, 2010 at 23:06 UTC
      The advantages or differences are explained in Spanish: nes.sourceforge.net all I need translation.

      We anticipate that the fundamental difference is: Nes Object

      Thank you.
        It is customary to include the documentation with your module or distribution and keep it all on CPAN.

        Given that there are already other good templating solutions, I would probably overlook your solution if I have to go out and find the documentation somewhere else. Also I keep a local minicpan on my laptop for when I am traveling and cannot connect to the internet. So any documentation outside of your module or distribution would be inaccessible then.

        CountZero

        A program should be light and agile, its subroutines connected like a string of pearls. The spirit and intent of the program should be retained throughout. There should be neither too little or too much, neither needless loops nor useless variables, neither lack of structure nor overwhelming rigidity." - The Tao of Programming, 4.1 - Geoffrey James