Index: docs/submissions.pod =================================================================== --- docs/submissions.pod (revision 43445) +++ docs/submissions.pod (working copy) @@ -22,18 +22,12 @@ However, if you do know how to fix the problem you encountered, then think about submitting a patch, or (see below) getting commit privileges. -=head1 How To Submit A Patch +=head1 How To Create A Patch Try to keep your patches specific to a single change, and ensure that your change does not break any tests. Do this by running C. If there is no test for the fixed bug, please provide one. -=over - -=item 1 - -Create the patch. - In the following examples, F contains the Parrot distribution, and F contains F. The name F is just a placeholder for whatever the distribution's parent directory is called on your machine. @@ -97,22 +91,30 @@ =back -=item 2 +=head1 How To Submit A Patch +=over + +=item 1 + Go to Parrot's ticket tracking system at L. Log in, or create an account if you don't have one yet. +=item 2 + +If there is already a ticket for the bug or feature that your patch relates +to, just attach the patch directly to the ticket. + =item 3 -Select "New Ticket" L. +Otherwise select "New Ticket" at the top of the site. +L =item 4 -Give a clear and concise Summary. +Give a clear and concise Summary, and prefix it with a C<[PATCH]> identifier. -Prefix it with a C<[PATCH]> identifier. - =item 5 The Description should contain an explanation of the purpose of the patch, and @@ -128,10 +130,9 @@ =item 7 -Check the box for "I have files to attach to this ticket" +Check the box for "I have files to attach to this ticket". Double-check +that you've actually done this, because it's easy to forget. -Double-check that you've actually done this, because it's easy to forget. - B paste the patch file content into the Description. =item 8 @@ -247,27 +248,23 @@ =head1 What Happens Next? -Trac creates a ticket for the submission, and you will receive an automatic reply -with details of the ticket identifier. This identifier should be used in all -further correspondence concerning the submission. +If you created a new ticket for the submission, you will be taken to the page +for the new ticket and can check on the progress of your submission there. +This identifier should be used in all correspondence concerning the submission. -Everyone on the list sees the submission, and can comment on it. A developer -with SVN commit authority will commit it to SVN once it is clear that it is the +Everyone on Trac sees the submission, and can comment on it. A developer with +SVN commit authority can commit it to SVN once it is clear that it is the right thing to do. -Even developers with SVN commit authority stick to this scheme for larger or -more complex changes, to allow time for peer review. +However developers with SVN commit authority may not commit your changes +immediately if they are large or complex, to allow time for peer review. -You can check the progress of your submission at the Parrot bugs page -L. If you have trouble logging in try username C -with password C. +A list of active tickets can be found here: +L -A Parrot Bug Summary page is also available from -L +A list of all the unresolved patches is at: +L -A list of all the unresolved patches is at -L - =head1 Patches for the Parrot website The L website is hosted in a Drupal CMS. Submit @@ -302,8 +299,8 @@ =item 4 Request commit access via the C mailing list, or via IRC -(#parrot on irc.parrot.org). The existing committers will discuss your request in -the next couple of weeks. +(#parrot on irc.parrot.org). The existing committers will discuss your +request in the next couple of weeks. If approved, a metacommitter will update the permissions to allow you to commit to Parrot; see C for the current list. Welcome aboard!