Revision: 4049
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=4049&view=rev
Author:   jdh2358
Date:     2007-10-29 07:53:09 -0700 (Mon, 29 Oct 2007)

Log Message:
-----------
updates to patches instructions

Modified Paths:
--------------
    trunk/py4science/doc/py4science.patches

Modified: trunk/py4science/doc/py4science.patches
===================================================================
--- trunk/py4science/doc/py4science.patches     2007-10-29 14:48:20 UTC (rev 
4048)
+++ trunk/py4science/doc/py4science.patches     2007-10-29 14:53:09 UTC (rev 
4049)
@@ -3,45 +3,51 @@
 
 1) get an svn checkout of the py4science dir.  
    
-    > svn co 
https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/py4science
+     > svn co 
https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/py4science
 
-  If you already have a checkout (eg on the machine we worked on in
-  the classroom), you just need to do
+   If you already have a checkout, you just need to do
 
-  > svn up
+     > svn up
 
-  If you are a windows user, you may want to checkout TortoiseSVN at
-  http://tortoisesvn.tigris.org.
+   If you are a windows user, you may want to checkout TortoiseSVN at
+   http://tortoisesvn.tigris.org.  
 
 2) Find something to fix or contribute.  You can fix a typo in the
    workbook, some code in the examples or skeletons, add your own
    examples, write better explanations or comments in the workbbok,
    examples, or skeletons, or even fix this document you are reading
    now, which lives in doc/py4science.patches in the svn repository.
-   Make the changes in your local repository.
+   Make the changes in your local repository.  The more you do the
+   better.  For example, you might want to add a document to the doc
+   subdirectory explaining how to install and use TortiseSVN with
+   py4science for windows users, but if you do this don't forget to
+   edit the py4science.patches document to to remove this suggestion!
 
-3) If you fix something, test it.  If you mkodify an example, make
+3) If you fix something, test it.  If you modify an example, make
    sure it still runs and generates the desired output and figures.
    If you modify the TeX source of the workbook, make sure you can
-   compile it with pdflatex and view the output main.pdf.  Once you
-   patch is accepted, it will affect py4science users worldwide, so
-   try and get it right!
+   compile it with pdflatex and view the output main.pdf.  
 
+     > pdflatex main
+
+   Once your patch is accepted, it will affect py4science users
+   worldwide, so try and get it right!
+
 4) Do an svn diff to create a patch file.  Try and make the patch name
    meaningful, eg if you are creating a patch for the FFT denoising
    explanation in the workbook, do something like
 
-   > svn diff > fft_denoise.patch
+     > svn diff > fft_denoise.patch
 
 5) Send the patch to the py4science mailing list by mailing
    [EMAIL PROTECTED]  If you are not already subscribed, you
    can do so at
 
-   http://code.astraw.com/cgi-bin/mailman/listinfo/py4science    
+     http://code.astraw.com/cgi-bin/mailman/listinfo/py4science    
 
    (after you subscribe, you will get a confirmation email and you
    will need to click on the confirm link).  When sending your patch,
-   send a brief explanation of the problemand solution with a helpful
+   send a brief explanation of the problem and solution with a helpful
    subject header, and *attach* your patch rather than paste it into
    the email browser.  If you don't get any response on your patch
    (eg, "Thanks, I've committed this to svn revision 4096" or "I don't


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins

Reply via email to