Changes between Version 1 and Version 2 of CheckinPolicy


Ignore:
Timestamp:
08/20/10 16:21:59 (4 years ago)
Author:
dread
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • CheckinPolicy

    v1 v2  
    11CKAN is open source and contributions are welcome. However, we have some guidelines for check-ins to ensure that all developers can work well together. 
    22 
    3  1. Work on the right branch - see VersionsAndBranching 
     3=== Check-ins === 
     4 1. Work on the right branch - see VersionsAndBranching. 
    45 1. Write tests for all changes. Unit tests go into ckan/tests/{area}/ and functional tests go into ckan/tests/functional/ . Tests describe intent and stop the code regressing in the future. 
    5  1. Run all the tests before you commit your code. It only takes 5 minutes 
     6 1. Run all the tests before you commit your code. It only takes 5 minutes! {{{nosetests ckan/tests}}} 
    67 
    7 Starting out: 
    8  * Before you can commit changes to the OKF repo, you'll need access rights - ask for these on [[CkanDiscuss|ckan-discuss]]. 
     8=== Starting out === 
     9 * Before you can commit changes to the OKF repo, you'll need access rights - ask for these on [CkanDiscuss ckan-discuss]. 
    910 
    10 Life-cycle of a change: 
     11=== Life-cycle of a change === 
    1112Unless it is a terribly minor change: 
    12  * Create a ticket with your suggestion and design detail as necessary 
    13  * Send a link to the ticket to [[CkanDiscuss|ckan-discuss]] and ask for suggestions 
     13 * Create a ticket with your suggestion and design detail as necessary. 
     14 * Send a link to the ticket to [CkanDiscuss ckan-discuss] and ask for suggestions. 
    1415 * Do it, whilst leaving the repo in a good state at all times (i.e. builds and works). Use another branch or bitbucket if necessary. 
    15  * Announce it on [[CkanDiscuss|ckan-discuss]] and close the ticket when done. 
     16 * Announce it on [CkanDiscuss ckan-discuss] and close the ticket when done. 
    1617 
    17 Don't break the build: 
    18  * Keep an eye on [[http://buildbot.okfn.org/waterfall|buildbot]] to make sure you don't break the build. If you're a regular developer, ask to be added to the buildbot emails. Don't wait to be nagged by other frustrated developers ;-) 
    19  * If you break the build, please fix it quickly. If it may take time then email [[CkanDiscuss|ckan-discuss]] to let others know what the plan is. 
     18=== Don't break the build === 
     19 * Keep an eye on [http://buildbot.okfn.org/waterfall buildbot] to make sure you don't break the build. If you're a regular developer, ask to be added to the buildbot emails. Don't wait to be nagged by other frustrated developers ;-) 
     20 * If you break the build, please fix it quickly. If it may take time then email [CkanDiscuss ckan-discuss] to let others know what the plan is.