Hi Shirl (and the esteemed module-authors mailing list),

We've talked a little in private about
https://metacpan.org/release/Freecell-App after this post to fc-solve-discuss
- http://tech.groups.yahoo.com/group/fc-solve-discuss/message/1336 - and I
mentioned the fact that in the Perl/CPAN community prefer to avoid adding more
top-level namespaces on CPAN , and you mentioned that you had to fix
t/pod-coverage.t too in case Pod::Coverage was installed, but here is some more
advice from a cursory browse of the code.

I'm CCing this message to module-authors@perl.org because it may be of general
interest and should be googlable, so if you want to CC the list on your reply,
hit reply-to-all (it accepts messages from non-subscribers).

1. Are you using a version control system for Freecell::App? If not, you
should. See:

* http://perl-begin.org/tutorials/bad-elements/#version_control

And:

* http://szabgab.com/license-and-repository-of-cpan-packages.html

2. Related to it is the fact that the file
https://metacpan.org/source/SHIRHA/Freecell-App-0.03/Changes was not kept
up-to-date. It should mention the changes done in each release. Some authors
use their version control system's logs to generate it, but normally you should
mention the major changes that you select yourself in every release. Also see:

https://metacpan.org/module/CPAN::Changes 

3. This is also still a generic file, while it should not contain the
boilerplate
- https://metacpan.org/source/SHIRHA/Freecell-App-0.03/README

4. https://metacpan.org/module/Freecell::App should mention metacpan.org in the
links too. Furthermore, ::App by convention should be modulinos - 

http://www.slideshare.net/brian_d_foy/advanced-modulinos-trial

The algorithmic logic of the solver should be outside the modulino. See for
instance:

https://metacpan.org/module/AI::Pathfinding::OptimizeMultiple::App::CmdLine

vs:

https://metacpan.org/module/AI::Pathfinding::OptimizeMultiple

5.
https://metacpan.org/source/SHIRHA/Freecell-App-0.03/lib/Freecell/App/Tableau.pm
- please consider adding more emptying lines between code paragraphs, giving
more meaningful variable names and getting rid of
http://en.wikipedia.org/wiki/Magic_number_%28programming%29 . For more about
that see: http://perl-begin.org/tutorials/bad-elements/ .

====================

That's all I can find from a cursory look, but it should keep you a little busy
for a while. Thanks for your contribution to CPAN and to the world of Freecell
solvers. I may draw some inspiration from your solver into my own.

Best regards,

        Shlomi Fish

-- 
-----------------------------------------------------------------
Shlomi Fish       http://www.shlomifish.org/
Beginners Site for the Vim text editor - http://vim.begin-site.org/

I used to be arrogant. Now I’m simply Perfect.
    — one of Shlomi Fish’s relatives.

Please reply to list if it's a mailing list post - http://shlom.in/reply .

Reply via email to