Login
Update instructions on generating docs for perlcritic.com site.
[gknop/Perl-Critic.git] / README.developer
CommitLineData
4e26cfd0
ES
1General development: While there is Makefile.PL/EU::MM support within the
2distribution, a lot of the authoring stuff depends upon Build.PL/M::B, in
735f2f46 3particular, running author tests. Only do releases using M::B.
4e26cfd0
ES
4
5Naming standard: Things that are distribution-private (as opposed to
6class/package-private) begin with double underscore.
68a933bc 7
b672fd9e
CD
8Steps for adding a new Policy:
9
ed2cc500 10 * Create tests in t/[category]/[name].run
8de08c2e 11 * Create the .pm in lib/Perl/Critic/Policy/[category]/[name].pm
68a933bc
ES
12 * If it applies_to() PPI::Document, perhaps add an exception in
13 t/03_pragmas.t
b672fd9e 14 * Mention it in Changes
68a933bc 15 * svn add t/[category]/[name].run lib/Perl/Critic/Policy/[category]/[name].pm
de772f0f 16 * tools/svnkeywords t/[category]/[name].run lib/Perl/Critic/Policy/[category]/[name].pm
fc1186f9
CD
17
18 * Remove from TODO
9475ffe2 19 * After release, set co-maint in PAUSE
799d11af
JRT
20
21Command for generating POD for perlcritic.com site:
22
c5caef8c 23perl -MPod::Simple::HTMLBatch -e 'Pod::Simple::HTMLBatch::go' lib ../../perlcritic.com/htdocs/pod/