forked from Perl-Critic/Perl-Critic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.developer
34 lines (22 loc) · 1.03 KB
/
README.developer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
## Naming Standard
Things that are distribution-private (as opposed to class/package-private)
begin with double underscore.
## Steps for adding a new Policy:
* Create tests in t/[category]/[name].run
* Create the .pm in lib/Perl/Critic/Policy/[category]/[name].pm
* If it applies_to() PPI::Document, perhaps add an exception in t/03_pragmas.t
* Mention it in Changes
* Remove from TODO
* After release, set co-maint in PAUSE
## Command for generating POD for perlcritic.com site:
perl -MPod::Simple::HTMLBatch -e 'Pod::Simple::HTMLBatch::go' lib ../../perlcritic.com/htdocs/pod/
## Branching
Development is *not* done on master. We use a dev branch named
`dev`, and from there topic branches named for a specific topic.
master -> dev -> docs
\-> speedups
\-> issue473
The only time we merge `dev` down to `master` is when doing a
release. `master` is always the latest released code, and `dev`
is where work pending release is accumulated. There are no branches
off of `master` other than `dev`.