.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Type::Tiny::Manual::Contributing 3" .TH Type::Tiny::Manual::Contributing 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Type::Tiny::Manual::Contributing \- contributing to Type::Tiny development. .SH MANUAL .IX Header "MANUAL" .SS "Reporting bugs" .IX Subsection "Reporting bugs" Bug reports (including wishlist items) can be submitted to GitHub. .PP . .PP Test cases written using Test::More are always appreciated. .SS "Fixing bugs" .IX Subsection "Fixing bugs" If something doesn't work as documented, or causes unexpected crashes, and you know how to fix it, then either attach a patch to the bug report (see above) or as a pull request to the project on GitHub. .PP . .PP Please try to follow the coding style used in the rest of the project. (Tab indents, spaces for alignment, British English spellings, pod at the end of code but the start of test cases, etc.) .PP .SS "Adding Test Cases" .IX Subsection "Adding Test Cases" New test cases for the Type::Tiny test suite are always welcome. The coveralls page for Type::Tiny should reveal what parts of the code are most needing good test cases. Any files with below 95% coverage are highest priority. .PP . .PP Type::Tiny is now also on Codecov which does coverage accounting slightly differently, giving some stricter targets to aim for. .PP .SS Type::Tiny::XS .IX Subsection "Type::Tiny::XS" I'm not really a C programmer, nor am I that familiar with Perl's internals, so help with Type::Tiny::XS is always appreciated. There are some type constraints in Types::Standard, Types::Common::String, and Types::Common::Numeric which don't have XS implementations. .SS "Writing Type Libraries" .IX Subsection "Writing Type Libraries" Though I'm unlikely to bundle many more type libraries in this distribution, uploading your own type libraries to CPAN will strengthen the Type::Tiny ecosystem. .SS Donate .IX Subsection "Donate" If you or your organization uses Type::Tiny and you wish to contribute financially, you should be able to find links to donate on the Type::Tiny website at . .PP Please note that I am not suggesting that you must do this in order for me to continue working on Type::Tiny and related modules. .SH "NEXT STEPS" .IX Header "NEXT STEPS" You've reached the end of the manual! .PP But each class, type library, and other package includes more detailed documentation. .SH "SEE ALSO" .IX Header "SEE ALSO" . .SH AUTHOR .IX Header "AUTHOR" Toby Inkster . .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2013\-2014, 2017\-2023 by Toby Inkster. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "DISCLAIMER OF WARRANTIES" .IX Header "DISCLAIMER OF WARRANTIES" THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.