cvs: peardoc /ru/contributing howto.xml skeleton.xml

kvn Tue Jan 15 08:50:15 2002 EDT Added files: /peardoc/ru/contributing howto.xml skeleton.xml Log: Let's go. ---------------------------------------------------------------------- Index: peardoc/ru/contributing/howto.xml +++ peardoc/ru/contributing/howto.xml <?xml encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <chapter id="contributing-howto"> <title>How to contribute to PEAR</title> <simpara> This chapter describes how to contribute to the PEAR project. </simpara> <sect1 id="contributing-introduction"> <title>Introduction</title> <para>Since PEAR is an open-source project, everybody is welcomed to contribute to it.</para> <para>In order to keep the whole project well organized and to create a clear structure, we have decided to set up some common rules, everybody has to stick to when he want's to contribute to PEAR.</para> </sect1> <sect1 id="contributing-requirements"> <title>Requirements</title> <para>If you have written something, that you think should belong to PEAR, you have to pay attention to the following points:</para> <para> <itemizedlist> <listitem> <simpara>Your code has to be compliant to the <ulink url=" standards.php">PEAR coding standards</ulink>. This is necessary because PEAR has the aim to provide well suited and standards compliant source code.</simpara> </listitem> <listitem> <simpara>You are willing and able to maintain your code and to fix upcoming bugs in your code once you have commited it to the PEAR project. </simpara> </listitem> <listitem> <simpara>You are willing document your code in an appropriate way. The prefered way of documentation is Docbook XML.</simpara> </listitem> </itemizedlist> </para> </sect1> <sect1 id="contributing-introducing"> <title>Introducing your code</title> <para>Once you can verify that all the requirements listed above are ok for you, you can tell us about your plan.</para> <para>The best way to do so is to tell the people on the <ulink url="mailto:&email.pear.dev">PEAR developers mailinglist</ulink> about your code. You should present us the following information:</para> <para> <itemizedlist> <listitem> <simpara>What does your code do? (should be as verbose as possible)</simpara> </listitem> <listitem> <simpara>Where can we have a look at the code (best thing is to tell us an URL where we can view the source)?</simpara> </listitem> <listitem> <simpara>What requirements/dependencies does your code have?</simpara> </listitem> </itemizedlist> </para> <para>We will then (hopefully) start discussing about your code and we'll decide, if we accept your contribution or not. (Don't be afraid, that your code will not be taken, although it is good: If it is well developed and we think it can be useful for some people out there, we will take it for sure.)</para> </sect1> </chapter> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/ru/contributing/skeleton.xml +++ peardoc/ru/contributing/skeleton.xml <?xml version='1.0' encoding='ISO-8859-1' ?> <!-- $Revision: 1.1 $ --> <!-- The value for id has to be 'packages' followed by the name of your package --> <article id="packages.skeleton" class="journalarticle"> <artheader> <!-- The name of your package goes here --> <title>Skeleton for creating PEAR docbook documentation</title> <!-- The date is set by CVS, so please don't change it --> <date>$Date: 2002/01/15 13:50:15 $</date> </artheader> <simpara>You can get the XML soure file for the skeleton <ulink url="&url.docbook.skeleton">here</ulink></simpara> <!-- the blank lines are not necessary --> <section id="packages.skeleton.classname"> <title>Classname</title> <para>This is a paragraph, where you can put text in.</para> <itemizedlist> <listitem> <para>The first item in the itemized list</para> </listitem> <listitem> <para>An itemized list is comparable with &lt;ul&gt;&lt;li&gt;&lt;/li&gt;&lt;/ul&gt; in HTML </para> </listitem> </itemizedlist> <para><emphasis>Emphase</emphasis> something, could transform in cursive or bold in other formats like PDF or HTML </para> <programlisting role="php"> // Often, you have to add programing examples. // Everything between the CDATA-section is treaten "as is" // including tabs(!) go_ahead() ; </programlisting> <para> <function>This_is_a_functionname</function> and <classname>i_am_the_name_of_a_class</classname> or do you want to describe a <parameter>parameter</parameter>? </para> </section> </article>