Debian Codegraph @

upstream/debian-unstable/man3/Test2::Manual::Contributing.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Test2::Manual::Contributing 3perl"
58 .TH Test2::Manual::Contributing 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Manual::Contributing \- How to contribute to the Test2 project.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This is a short manual page dedicated to helping people who wish to contribute
68 to the Test2 project.
69 .SH "WAYS TO HELP"
70 .IX Header "WAYS TO HELP"
71 .SS "REPORT BUGS"
72 .IX Subsection "REPORT BUGS"
73 The easiest way to help is to report bugs when you find them. Bugs are a fact
74 of life when writing or using software. If you use Test2 long enough you are
75 likely to find a bug. When you find such a bug it would help us out if you
76 would submit a ticket.
77 .PP
78 \fIBUG TRACKERS\fR
79 .IX Subsection "BUG TRACKERS"
80 .PP
81 Always try to find the preferred bug tracker for the module that has the bug.
82 Here are the big 3 for the main Test2 project:
83 .IP Test2/Test\-Builder/Test\-More 4
84 .IX Item "Test2/Test-Builder/Test-More"
85 <https://github.com/Test\-More/test\-more/issues>
86 .IP Test2\-Suite 4
87 .IX Item "Test2-Suite"
88 <https://github.com/Test\-More/Test2\-Suite/issues>
89 .IP Test2\-Harness 4
90 .IX Item "Test2-Harness"
91 <https://github.com/Test\-More/Test2\-Harness/issues>
92 .SS "SUBMIT PATCHES"
93 .IX Subsection "SUBMIT PATCHES"
94 You are welcome to fix bugs you find, or from the tracker. We also often accept
95 patches that add new features or update documentation. The preferred method of
96 submitting patches is a github pull request, that said we also accept patches
97 via email.
98 .SS "ADD/UPDATE DOCUMENTATION"
99 .IX Subsection "ADD/UPDATE DOCUMENTATION"
100 Documentation can be flawed just like code can be. Documentation can also
101 become outdated. If you see some incorrect documentation, or documentation that
102 is missing, we would love to get a patch to fix it!
103 .SS "ANSWER QUESTIONS ON IRC/SLACK"
104 .IX Subsection "ANSWER QUESTIONS ON IRC/SLACK"
105 We are always hanging out on <irc://irc.perl.org>, the #perl\-qa and #toolchain
106 channels are a good place to find us.
107 .PP
108 There is also a Test2 slack channel: <https://perl\-test2.slack.com>.
109 .SS "WRITE NEW TOOLS USING TEST2"
110 .IX Subsection "WRITE NEW TOOLS USING TEST2"
111 Writing a new tool using Test2 is always a good way to contribute. When you
112 write a tool that you think is useful, it is nice to share it by putting it on
113 CPAN.
114 .SS "PORT OLD TOOLS TO TEST2"
115 .IX Subsection "PORT OLD TOOLS TO TEST2"
116 The \f(CW\*(C`Test::*\*(C'\fR namespace has been around for a long time, and has a LOT of
117 tools. The \f(CW\*(C`Test2::Tools::*\*(C'\fR namespace is fairly young, and has less tools.
118 Finding a useful old tool with no modern equivalent, and writing a port is a
119 very good use of your time.
120 .SH "SEE ALSO"
121 .IX Header "SEE ALSO"
122 Test2::Manual \- Primary index of the manual.
123 .SH SOURCE
124 .IX Header "SOURCE"
125 The source code repository for Test2\-Manual can be found at
126 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
127 .SH MAINTAINERS
128 .IX Header "MAINTAINERS"
129 .IP "Chad Granum <[email protected]>" 4
130 .IX Item "Chad Granum <[email protected]>"
131 .SH AUTHORS
132 .IX Header "AUTHORS"
133 .PD 0
134 .IP "Chad Granum <[email protected]>" 4
135 .IX Item "Chad Granum <[email protected]>"
136 .PD
137 .SH COPYRIGHT
138 .IX Header "COPYRIGHT"
139 Copyright 2018 Chad Granum <[email protected]>.
140 .PP
141 This program is free software; you can redistribute it and/or
142 modify it under the same terms as Perl itself.
143 .PP
144 See \fIhttp://dev.perl.org/licenses/\fR