There has been talk of things that need to be updated in the programming guide. Here is a short list (also on trac at http://trac.sagemath.org/sage_trac/ticket/2422 ). Is there anything else? You might add your comments to the trac ticket.
The programming guide should be updated: 1. Instructions about working with trac (posting a patch, the "[with patch, needs review]", the review process, etc.) 2. Expectations for patches (doctests and documentation, clean code, can be slow as an initial version, but if it's a naive way to do things when it could be faster, it should probably be mentioned, references for algorithms if it is an algorithm from a paper, etc.) 3. Instructions on creating patches instead of bundles, maybe a short introduction to queues. 4. Say that you really should go ask people to review your patch and then follow up and make sure the patch doesn't fall through the cracks. 5. Instructions for running the doctests to check for failures. 6. Expectations and instructions for creating spkgs Also, we probably ought to reorganize the guide so that it's very, very easy for a person to pick it up and start doing at least small fixes. Maybe put the short mercurial tutorial in the very front with a small documentation-fixing example or an example of adding a simple function. Jason --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
