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

Timestamp:

May 30, 2016 6:00:04 AM (8 years ago)

Author:

wojciech

Comment:

—

DevNotes/DevGuide/CodingRules

@@ -26 +26 @@
 * API interface (to be included in the future)
 
-Golden Rule:
+== Golden Rule: ==
 
     '''The committed code should NEVER break the build.'''
     '''If you do break the build - the no. 1 priority is to fix it IMMEDIATELY.'''
 
-Coding Standards
+== Coding Standards ==
 
 Docstring
@@ -148 +148 @@
     * Use inline comments (sparingly) to clarify confusing lines.
 
-Testing
+== Testing ==
 
     * Unit tests should test one method only. This allows you to easily identify what failed if the test fails.
@@ -162 +162 @@
     * Models: Remember to test a model for critical values (e.g. q=0)
 
-GIT
+== GIT ==
 
     * Remember to add files using git add before committing your changes.
@@ -169 +169 @@
     * When merging a branch with multiple commits use --squash or interactively rebase before pushing to master.
 
-Code Reviews
+== Code Reviews ==
 
     * Code reviews by another developer are encouraged for minor functionality and required for major changes
@@ -182 +182 @@
         7. Verify that the defects are actually fixed
 
-Editors
+== Editors ==
 
     * Tips and tricks of how to make your life easier when developing code with your favorite editor.
@@ -192 +192 @@
      * Both PyCharm and VS allow source level debugging both of self-spawned processes and by attaching to an already running process.
 
-API
+== API == 
 
 The proposed access to the core functionality should be consistent for all perspectives and straightforward to use.