Code

Changes between Version 1 and Version 2 of SprintIdeas


Ignore:
Timestamp:
09/13/07 12:23:15 (7 years ago)
Author:
adrian
Comment:

Small edits

Legend:

Unmodified
Added
Removed
Modified
  • SprintIdeas

    v1 v2  
    1 = Choosing Something To Work On = 
     1= Choosing something to work on = 
    22 
    33You can work on whatever you like. In a way, this is normal Django development, with the advantage/difference that a lot of people are going to be in more or less realtime contact. Some groups will be in the same physical location and the IRC channel will be available for more rapid feedback. 
     
    55If you are in doubt about what to work on, choose to fix existing bugs, rather than add enhancements. Bugs are cases where we know something is not working correctly or as documented. Enhancements require a bit more of a judgement call from the maintainers about whether to include the feature and one big goal of the sprint is to try and ''reduce'' the number of open tickets by getting patches committed and tickets closed. 
    66 
    7 == "Big" Items == 
     7== "Big" items == 
    88 
    99If you are going to work on a really big item, either individually or as a group, remember to respect normal practices. Post a summary of any big discussions you have to the [http://groups.google.com/group/django-developers/about django-developers] mailing list.  
     
    1111Remember that not everybody is going to be online all the time and those that are may well be busy on other things. So large changes or things requiring community input will have to go through the usual, archived channels. That being said, an online or in-person discussion can get a lot further quickly and then you can post a more comprehensive plan and summary than normal. So there are advantages to doing some design work in a sprint setting. 
    1212 
    13 == Working On Smaller Items == 
     13== Working on smaller items == 
    1414 
    1515The biggest contribution everybody can make during a sprint is to help confirm bug reports, write patches, review proposed solutions and help get the tickets closed. 
     
    1919 * Search for tickets in that '''component''' in Trac (one of the search filters is on the component type). 
    2020 * Read through the ticket titles until you find something interesting and try to replicate the bug. 
    21  * Once you've found a ticket that interests you, assign it to yourself so that somebody else doesn't accidentally duplicate the work. 
    22  * If possible, write a test to duplicate the problem. Django's tests are in the tests/ directory. Copy existing tests as a start. If possible, look for an appropriate file to add your new test to, rather than starting a new file. But if you are working on a totally untested area, start a new file. 
     21 * Once you've found a ticket that interests you, [http://www.djangoproject.com/documentation/contributing/#claiming-tickets claim it], so that somebody else doesn't accidentally duplicate the work. 
     22 * If possible, write a test to duplicate the problem. Django's tests are in the {{{tests/}}} directory. Copy existing tests as a start. If possible, look for an appropriate file to add your new test to, rather than starting a new file. But if you are working on a totally untested area, start a new file. 
    2323 * Write a patch, whether that is code or documentation to fix the problem. 
    2424 * Attach the patch to the ticket. 
     
    2828Don't worry if it takes you longer than other people to write fixes initially. Some areas are genuinely harder than others. Some problems are disguised versions of something much bgiger, so it might take a couple of attempts to get something that satisfies the maintainers. Not to worry; any serious patch is better than no patch because it gives us something to start from and incrementally improve. 
    2929 
    30 == Areas Requiring Caution == 
     30== Areas requiring caution == 
    3131 
    3232There are a few areas in Django that are undergoing some fairly major change. Have care if you are wanting to work in the following areas. 
    3333 
    34 === Admin Interface === 
     34=== Admin interface === 
    3535 
    3636Joseph Kocherhans is leading the charge to finish the NewformsAdminBranch, which will replace the existing admin code as soon as possible. 
     
    4040By all means, pick some admin tickets to work on. However, read the ticket and try to repeat the problem on newforms-admin. Then write a patch against that branch, rather than trunk. 
    4141 
    42 === Database Query Construction === 
     42=== Database query construction === 
    4343 
    4444There are a lot of tickets concerning bad SQL constructs from the ORM. Malcolm Tredinnick is working in the QuerysetRefactorBranch to fix a lot of these. Right now, that branch is not in a usable state for any serious code; large pieces remain to be ported.