Hi all,
during a train ride w/o internet access I went through the plug-ins in
the Padre repository to try out some of them (I was bored ;-), and found
that many of them lack documentation, in particular README files.
I know, coding is more fun than documenting stuff (at least for most people),
so I understand that this is often not done properly.
However consider that people are more likely to try out your plug-in if
they have an idea what the plug-in is useful for, and will also put more
trust into your code if it is nicely documented.
So if you are a plug-in author, or have experience using a plug-in,
consider stepping up and fixing some of the README files mentioned below.
Ideally, this would go along with a check if the plug-in still works with
the current Padre release ;-)
This should also not be too hard for people who want to get started with
Padre (plug-in) development -- at least with some help from the IRC
channel ...
Some of the README files are only boilerplate texts provided by the different
distribution generators, possibly with the name of the module but no other
information (1), some do not contain boilerplate text, but lack even a
one-line description of what the plug-in does (2), some contain no README
file at all (3), and some README files are incomplete (4).
For completeness, I also attached a list of plug-ins that do have a README
file with some useful information:
1. only boilerplate:
Catalyst, CSS, Encrypt, LineFilter, ViewInBrowser, WebGUI, XML
2. no one-liner:
ClassSniff, CommandLine, GUITest, Kate, Mojolicious, Parrot, Perldoc,
PHP, PSI, SDL, SVK, SVN, Vi
3. no README:
BadCode, ConfigSync, DataWalker, HTTPRecordReplay, IntelliPerl, Media,
NYTProf, PerlTidy, Plack, SQL, SSH, Tasks, wxGlade, XS
4. incomplete README:
JavaScript
5. okay:
Alarm, Autodia, Autoformat, HTMLExport, InstallPARDist, Nopaste, PAR,
PerlCritic, REPL, ShellScript, SpellCheck, Swarm, VimishLexer
My girlfriend is out of town next weekend, I will go hiking on Saturday,
but on Sunday it is likely that I'll join the Padre Birthday
Hackathon for a while.
Best regards,
Zeno
_______________________________________________
Padre-dev mailing list
Padre-dev@perlide.org
http://mail.perlide.org/mailman/listinfo/padre-dev
