Ticket #1409: submissions.pod.patch

File submissions.pod.patch, 4.2 KB (added by Aninhumer, 5 years ago)

Changes to submissions.pod

  • docs/submissions.pod

     
    2222However, if you do know how to fix the problem you encountered, then think 
    2323about submitting a patch, or (see below) getting commit privileges. 
    2424 
    25 =head1 How To Submit A Patch 
     25=head1 How To Create A Patch 
    2626 
    2727Try to keep your patches specific to a single change, and ensure that your 
    2828change does not break any tests.  Do this by running C<make test>.  If there is 
    2929no test for the fixed bug, please provide one. 
    3030 
    31 =over 
    32  
    33 =item 1 
    34  
    35 Create the patch. 
    36  
    3731In the following examples, F<parrot> contains the Parrot distribution, and 
    3832F<workingdir> contains F<parrot>. The name F<workingdir> is just a placeholder 
    3933for whatever the distribution's parent directory is called on your machine. 
     
    9791 
    9892=back 
    9993 
    100 =item 2 
     94=head1 How To Submit A Patch 
    10195 
     96=over 
     97 
     98=item 1 
     99 
    102100Go to Parrot's ticket tracking system at 
    103101L<https://trac.parrot.org/parrot/>. Log in, or create an account if you 
    104102don't have one yet. 
    105103 
     104=item 2 
     105 
     106If there is already a ticket for the bug or feature that your patch relates 
     107to, just attach the patch directly to the ticket. 
     108 
    106109=item 3 
    107110 
    108 Select "New Ticket" L<https://trac.parrot.org/parrot/newticket>. 
     111Otherwise select "New Ticket" at the top of the site. 
     112L<https://trac.parrot.org/parrot/newticket> 
    109113 
    110114=item 4 
    111115 
    112 Give a clear and concise Summary. 
     116Give a clear and concise Summary, and prefix it with a C<[PATCH]> identifier. 
    113117 
    114 Prefix it with a C<[PATCH]> identifier. 
    115  
    116118=item 5 
    117119 
    118120The Description should contain an explanation of the purpose of the patch, and 
     
    128130 
    129131=item 7 
    130132 
    131 Check the box for "I have files to attach to this ticket" 
     133Check the box for "I have files to attach to this ticket". Double-check 
     134that you've actually done this, because it's easy to forget. 
    132135 
    133 Double-check that you've actually done this, because it's easy to forget. 
    134  
    135136B<DO NOT> paste the patch file content into the Description. 
    136137 
    137138=item 8 
     
    247248 
    248249=head1 What Happens Next? 
    249250 
    250 Trac creates a ticket for the submission, and you will receive an automatic reply 
    251 with details of the ticket identifier. This identifier should be used in all 
    252 further correspondence concerning the submission. 
     251If you created a new ticket for the submission, you will be taken to the page 
     252for the new ticket and can check on the progress of your submission there. 
     253This identifier should be used in all correspondence concerning the submission. 
    253254 
    254 Everyone on the list sees the submission, and can comment on it. A developer 
    255 with SVN commit authority will commit it to SVN once it is clear that it is the 
     255Everyone on Trac sees the submission, and can comment on it. A developer with 
     256SVN commit authority can commit it to SVN once it is clear that it is the 
    256257right thing to do. 
    257258 
    258 Even developers with SVN commit authority stick to this scheme for larger or 
    259 more complex changes, to allow time for peer review. 
     259However developers with SVN commit authority may not commit your changes 
     260immediately if they are large or complex, to allow time for peer review. 
    260261 
    261 You can check the progress of your submission at the Parrot bugs page 
    262 L<http://bugs6.perl.org/>. If you have trouble logging in try username C<guest> 
    263 with password C<guest>. 
     262A list of active tickets can be found here: 
     263L<http://trac.parrot.org/parrot/report/1> 
    264264 
    265 A Parrot Bug Summary page is also available from 
    266 L<https://rt.perl.org/rt3/NoAuth/parrot/Overview.html> 
     265A list of all the unresolved patches is at: 
     266L<http://trac.parrot.org/parrot/report/15> 
    267267 
    268 A list of all the unresolved patches is at 
    269 L<http://www.parrotcode.org/openpatches.html> 
    270  
    271268=head1 Patches for the Parrot website 
    272269 
    273270The L<http://www.parrot.org> website is hosted in a Drupal CMS. Submit 
     
    302299=item 4 
    303300 
    304301Request commit access via the C<parrot-dev> mailing list, or via IRC 
    305 (#parrot on irc.parrot.org).  The existing committers will discuss your request in 
    306 the next couple of weeks. 
     302(#parrot on irc.parrot.org). The existing committers will discuss your 
     303request in the next couple of weeks. 
    307304 
    308305If approved, a metacommitter will update the permissions to allow you to commit 
    309306to Parrot; see C<RESPONSIBLE_PARTIES> for the current list.  Welcome aboard!