From 5c0ef3a2633c0669aa4cad980278f7596d499d83 Mon Sep 17 00:00:00 2001 From: Martin Renvoize Date: Thu, 18 Jan 2024 13:45:38 +0000 Subject: [PATCH] Bug 35834: Add a starter 'Contributing.pod' This patch adds a starter Contributing.pod file so we can test out the new pod renderer approach in https://gitlab.com/mrenvoize/koha-pods --- Koha/Contributing.pod | 78 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 Koha/Contributing.pod diff --git a/Koha/Contributing.pod b/Koha/Contributing.pod new file mode 100644 index 00000000000..12ff73090d5 --- /dev/null +++ b/Koha/Contributing.pod @@ -0,0 +1,78 @@ +=encoding utf8 + +=head1 NAME + +Koha::Contributing - The Koha Guide to the contributing to the worlds greatest open source library management system + +=head1 BASICS + +=head2 Learning Perl + +If you are new to Perl, we recommend L for a quick +introduction, or the L, freely available +in many formats. Both are excellent introductions to the language. For more books and documentation, check out +L. + +=head2 Learning Web Technologies + +All web development starts with HTML, CSS and JavaScript, to learn the basics we recommend the L. And if you want to know more about how browsers and web servers +actually communicate, there's also a very nice introduction to +L. + +=head1 DON'T PANIC! + +The L are a friendly group and always welcoming to new contributors. + +=head1 CONVENTIONS + +=head2 Modern Perl + +L uses a modern subset of Perl exclusively, and therefore all documentation assumes that L, +L, L and Perl 5.16 L are enabled, even if examples don't specifically mention it. + + use strict; + use warnings; + use utf8; + use feature ':5.16'; + +Some modules, like L and L, will enable them for you automatically, whenever they are +used. + +=head2 Coding guidelines + +=head1 MODULES + +This is the class hierarchy of the L ILS. + +=over 2 + +=item * L + +=item * L + +=over 2 + +=item * L + +=item * L + +=item * L + +=item * L + +=back + +=back + +=head1 MORE + +A lot more documentation and examples by many different authors can be found in the L. + +=head1 SUPPORT + +If you have any questions the documentation might not yet answer, don't hesitate to ask on +L. + +=cut -- 2.43.0