Changes between Version 14 and Version 15 of DevNotes/DevGuide/CodingRules


Ignore:
Timestamp:
May 30, 2016 8:00:04 AM (6 years ago)
Author:
wojciech
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • DevNotes/DevGuide/CodingRules

    v14 v15  
    2626* API interface (to be included in the future) 
    2727 
    28 Golden Rule: 
     28== Golden Rule: == 
    2929 
    3030    '''The committed code should NEVER break the build.''' 
    3131    '''If you do break the build - the no. 1 priority is to fix it IMMEDIATELY.''' 
    3232 
    33 Coding Standards 
     33== Coding Standards == 
    3434 
    3535Docstring 
     
    148148    * Use inline comments (sparingly) to clarify confusing lines. 
    149149 
    150 Testing 
     150== Testing == 
    151151 
    152152    * Unit tests should test one method only. This allows you to easily identify what failed if the test fails. 
     
    162162    * Models: Remember to test a model for critical values (e.g. q=0) 
    163163 
    164 GIT 
     164== GIT == 
    165165 
    166166    * Remember to add files using git add before committing your changes. 
     
    169169    * When merging a branch with multiple commits use --squash or interactively rebase before pushing to master. 
    170170 
    171 Code Reviews 
     171== Code Reviews == 
    172172 
    173173    * Code reviews by another developer are encouraged for minor functionality and required for major changes 
     
    182182        7. Verify that the defects are actually fixed 
    183183 
    184 Editors 
     184== Editors == 
    185185 
    186186    * Tips and tricks of how to make your life easier when developing code with your favorite editor. 
     
    192192     * Both PyCharm and VS allow source level debugging both of self-spawned processes and by attaching to an already running process. 
    193193 
    194 API 
     194== API ==  
    195195 
    196196The proposed access to the core functionality should be consistent for all perspectives and straightforward to use.