1CPANPLUS::Hacking(3)  User Contributed Perl Documentation CPANPLUS::Hacking(3)
2
3
4

NAME

6       CPANPLUS::Hacking - developing CPANPLUS
7

DESCRIPTION

9       This document attempts to describe how to develop with the CPANPLUS
10       environment most easily, how certain things work and why.
11
12       This is basically a quick-start guide to people who want to add
13       features or patches to CPANPLUS.
14

OBTAINING CPANPLUS

16       Checkout CPANPLUS from its GIT repository at
17       <https://github.com/jib/cpanplus-devel> .
18

INSTALLING CPANPLUS

20       CPANPLUS follows the standard perl module installation process:
21
22           perl Makefile.PL
23           make
24           make test
25           make install
26

CONFIGURING CPANPLUS

28       When running "perl Makefile.PL" you will be prompted to configure.  If
29       you have already done so, and merely wish to update the "Makefile",
30       simply run:
31
32           perl Makefile.PL JFDI=1
33
34       This will keep your configuration intact. Note however, if there are
35       changes to the default configuration file "Config.pm-orig", you should
36       either delete your current config file and reconfigure, or patch your
37       config file from the new entries in "Config.pm-orig".
38

RUNNING CPANPLUS FROM DEVELOPMENT ENVIRONMENT

40       If you'd rather not install the development version to your "site_perl"
41       directory, that's no problem. You can set your "PERL5LIB" environment
42       variable to CPANPLUS' "lib" directory, and you can run it from there.
43

RUNNING CPANPLUS TESTS

45       Tests are what tells us if CPANPLUS is working. If a test is not
46       working, try to run it explicitly like this:
47
48           perl -I/path/to/cpanplus/lib t/XX_name_of_test.t 1
49
50       The extra '1' makes sure that all the messages and errors (they might
51       be errors we're testing for!) are being printed rather than kept quiet.
52       This is a great way to find out the context of any failures that may
53       occur.
54
55       If you believe this test failure proves a bug in CPANPLUS, the long
56       output of the test file is something we'd like to see alongside your
57       bug report.
58

FINDING BUGS

60       Sometimes you might find bugs in CPANPLUS' behaviour. If you encounter
61       these in a development snapshot, we'd appreciate a complete patch (as
62       described below in the "SENDING PATCHES" section.
63
64       If it's way over your head, then of course reporting the bug is always
65       better than not reporting it at all. Before you do so though, make sure
66       you have the latest development snapshot, and the bug still persists
67       there. If so, report the bug to this address:
68
69           bug-cpanplus@rt.cpan.org
70
71       A good "patch" would have the following characteristics:
72
73       Problem description
74           Describe clearly what the bug is you found, and what it should have
75           done instead.
76
77       Program demonstrating the bug
78           Show us how to reproduce the bug, in a simple of a program as
79           possible
80
81       [OPTIONAL] A patch to the test suite to test for the bug
82           Amend our test suite by making sure this bug will be found in this,
83           and future versions of CPANPLUS (see "SUPPLYING PATCHES")
84
85       [OPTIONAL] A patch to the code + tests + documentation
86           Fix the bug, update the docs & tests. That way your bug will be
87           gone forever :)
88

SUPPLYING PATCHES

90       Patches are a good thing, and they are welcome. Especially if they fix
91       bugs you've found along the way, or that others have reported.
92
93       We prefer patches in the following format:
94
95       •   In "diff -u" or "diff -c" format
96
97       •   From the root of the snapshot
98
99       •   Including patches for code + tests + docs
100
101       •   Sent per mail to bug-cpanplus@rt.cpan.org
102
103       •   With subject containing "[PATCH]" + description of the patch
104
105       You will always be informed if a patch is applied or rejected, and in
106       case of rejection why that is (perhaps you can tweak the patch to have
107       it accepted after all).
108
109
110
111perl v5.32.1                      2021-01-26              CPANPLUS::Hacking(3)
Impressum