Bugzilla – Attachment 161343 Details for
Bug 35834
Add a 'Contributing.pod' to the project as a starting point for developers
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 35834: Add a starter 'Contributing.pod'
Bug-35834-Add-a-starter-Contributingpod.patch (text/plain), 3.10 KB, created by
Martin Renvoize (ashimema)
on 2024-01-24 14:55:18 UTC
(
hide
)
Description:
Bug 35834: Add a starter 'Contributing.pod'
Filename:
MIME Type:
Creator:
Martin Renvoize (ashimema)
Created:
2024-01-24 14:55:18 UTC
Size:
3.10 KB
patch
obsolete
>From 7e972909418269ace390aa3c4ea22c982011d299 Mon Sep 17 00:00:00 2001 >From: Martin Renvoize <martin.renvoize@ptfs-europe.com> >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 | 73 +++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 73 insertions(+) > create mode 100644 Koha/Contributing.pod > >diff --git a/Koha/Contributing.pod b/Koha/Contributing.pod >new file mode 100644 >index 00000000000..deba42b36eb >--- /dev/null >+++ b/Koha/Contributing.pod >@@ -0,0 +1,73 @@ >+=encoding utf8 >+ >+=head1 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<Learn Perl in 2 hours 30 minutes|https://qntm.org/perl_en> for a quick >+introduction, or the L<Modern Perl book|https://pragprog.com/book/swperl/modern-perl-fourth-edition>, freely available >+in many formats. Both are excellent introductions to the language. For more books and documentation, check out >+L<learn.perl.org|https://learn.perl.org/>. >+ >+=head2 Learning Web Technologies >+ >+All web development starts with HTML, CSS and JavaScript, to learn the basics we recommend the L<Mozilla Developer >+Network|https://developer.mozilla.org/en-US/docs/Web>. And if you want to know more about how browsers and web servers >+actually communicate, there's also a very nice introduction to >+L<HTTP|https://developer.mozilla.org/en-US/docs/Web/HTTP>. >+ >+=head1 DON'T PANIC! >+ >+The L<Koha Community|https://koha-community.org> are a friendly group and always welcoming to new contributors. >+ >+=head1 CONVENTIONS >+ >+=head2 Modern Perl >+ >+L<Koha> uses L<Modern::Perl> exclusively, and therefore all documentation assumes that L<strict>, L<warnings>, L<utf8> >+and Perl 5.16 L<features|feature> are enabled, even if examples don't specifically mention it. >+ >+ use Modern::Perl; >+ >+=head2 Coding guidelines >+ >+The L<Koha community|https://koha-community.org> has a set of agreed L<coding guidlines|https://wiki.koha-community.org/wiki/Coding_Guidelines> >+that should be adhered to when submitting code to the project. >+ >+=head1 MODULES >+ >+This is the class hierarchy of the L<Koha> ILS. >+ >+=over 2 >+ >+=item * Koha >+ >+The Koha namespace contains object oriented koha code that adheres to our guidelines. All new modules should be submitted here. >+ >+=item * C4 >+ >+The C4 namespace contains our legacy modules, they are a mix of coding styles and a lot of the code here predates out current coding guidelines. >+ >+Modifications should be made spareingly here. >+ >+=item * L<Koha::Object> >+ >+=item * L<Koha::Objects> >+ >+=back >+ >+=head1 MORE >+ >+A lot more documentation and examples by many different authors can be found in the L<Koha >+wiki|https://wiki.koha-community.org>. >+ >+=head1 SUPPORT >+ >+If you have any questions the documentation might not yet answer, don't hesitate to ask on >+L<Matrix|https://app.element.io/#/room/#koha-community:matrix.org>. >+ >+=cut >-- >2.43.0
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 35834
:
161137
| 161343