Software Development Guidelines - Revision history

D.barra: /* Do not submit copyrighted material without permission */

2016-01-05T13:21:44Z

‎Do not submit copyrighted material without permission

D.barra: /* General */

2016-01-05T13:20:54Z

‎General

D.barra: Added new General section

2016-01-05T12:55:52Z

Added new General section

D.barra at 12:36, 4 January 2016

2016-01-04T12:36:19Z

D.barra: /* Testing */

2016-01-04T10:14:30Z

‎Testing

D.barra: /* Use appropriate tooling and facilities for testing */

2016-01-04T09:54:30Z

‎Use appropriate tooling and facilities for testing

D.barra: Added Testing section

2016-01-04T09:51:11Z

Added Testing section

D.barra: /* Name classes, functions, and variables as the language of your choice indicates */

2016-01-03T13:23:52Z

‎Name classes, functions, and variables as the language of your choice indicates

D.barra: /* Proposing a New Rule */

2016-01-03T13:19:58Z

‎Proposing a New Rule

D.barra: /* Name classes, functions, and variables as the language of your choice indicates */

2016-01-03T13:10:35Z

‎Name classes, functions, and variables as the language of your choice indicates

@@ Line 54: / Line 54: @@
 ; A.K.A. : Check the license of the software tools and libraries upon which you are basing your software.
 ; Importance : HIGH
-; Reason : Multi-million €/$ lawsuits may arise when powerful companies believe other people have used their own protected assets (such as copyrighted software). It is therefore of vital importance that you make sure you have the right to use somebody else's work for your purposes. OSI-approved [[https://opensource.org/licenses|licenses]] are generally OK - although they also have their subtle differences between each other - while software licensed under different conditions may be very dangerous. Do write a couple of lines to a [[The_Good_Dictators|dictator]] if you are unsure.
+; Reason : Multi-million €/$ lawsuits may arise when powerful companies believe other people have used their own protected assets (such as copyrighted software). It is therefore of vital importance that you make sure you have the right to use somebody else's work for your purposes. OSI-approved licenses ([[https://opensource.org/licenses]]) are generally OK - although they also have their subtle differences between each other - while software licensed under different conditions may be very dangerous. Do write a couple of lines to a [[#The_Good_Dictators|dictator]] if you are unsure.
 === Put a copyright disclaimer and software license in each source file ===

← Older revision		Revision as of 13:20, 5 January 2016
Line 50:		Line 50:
	If you don't feel comfortable modifying the code (because it's too tricky to touch it, or because you do not grasp the specific topics addressed by the software), or you just don't have enough time, open a ticket on the bug-tracking system, referencing the exact location of the offending code, along with your observations.		If you don't feel comfortable modifying the code (because it's too tricky to touch it, or because you do not grasp the specific topics addressed by the software), or you just don't have enough time, open a ticket on the bug-tracking system, referencing the exact location of the offending code, along with your observations.

		+
		+	=== Do not submit copyrighted material without permission ===
		+	; A.K.A. : Check the license of the software tools and libraries upon which you are basing your software.
		+	; Importance : HIGH
		+	; Reason : Multi-million €/$ lawsuits may arise when powerful companies believe other people have used their own protected assets (such as copyrighted software). It is therefore of vital importance that you make sure you have the right to use somebody else's work for your purposes. OSI-approved [[https://opensource.org/licenses\|licenses]] are generally OK - although they also have their subtle differences between each other - while software licensed under different conditions may be very dangerous. Do write a couple of lines to a [[The_Good_Dictators\|dictator]] if you are unsure.
		+
		+
		+	=== Put a copyright disclaimer and software license in each source file ===
		+	; Importance : MEDIUM
		+	; Reason : It may happen that a source file is moved somewhere else from where it originally belonged. In such cases, the license originally ''shipped'' with the file might not be available anymore. Putting a short disclaimer on top of the file help keeping track of licensing conditions.

	== Design ==		== Design ==

@@ Line 40: / Line 40: @@
 === Proposing a New Rule ===
 Write to the [[#The_Good_Dictators|dictators]] explaining your proposal, along with the reasons associated to it. It will be much appreciated.
 == Design ==

@@ Line 117: / Line 117: @@
 == Versioning ==
 == Testing ==
@@ Line 123: / Line 134: @@
 ; Importance: HIGH
 ; Reason : Untested code is dangerous for production. The traditional functional testing performed before a release only covers a portion of the software features: there are many more corner cases, which '''will''' happen in production, to be spotted beforehand. Only carefully written test cases, assisted by coverage statistics and code analysis, can really be of help on this account.
 === Make your Unit Tests self-consitent ===

@@ Line 119: / Line 119: @@
 == Testing ==
 === Use appropriate tooling and facilities for testing ===
 ; Importance: HIGH
 ; Reason : Tests are automated nowadays, sometimes ''highly'' automated. You can't expect somebody to call your custom <code>main()</code>, as if you do so your test simply won't be executed. Vice versa, if you rely on a standard and proven testing framework, running your test in a broader context will be much easier.
-; Example : On Java, use JUnit4 + Mockito/Powermock.
+; Suggestion : On Java, use JUnit4 + Mockito/Powermock.

← Older revision		Revision as of 09:51, 4 January 2016
Line 117:		Line 117:

	== Versioning ==		== Versioning ==
		+
		+	== Testing ==
		+	=== Use appropriate tooling and facilities for testing ===
		+	; Importance: HIGH
		+	; Reason : Tests are automated nowadays, sometimes ''highly'' automated. You can't expect somebody to call your custom <code>main()</code>, as if you do so your test simply won't be executed. Vice versa, if you rely on a standard and proven testing framework, running your test in a broader context will be much easier.
		+	; Example : On Java, use JUnit + Mockito/Powermock.

@@ Line 70: / Line 70: @@
 === Name classes, functions, and variables as the language of your choice indicates ===
 ; Importance : MEDIUM
 ; Reason : Staying consistent with naming helps to improve readability. There's no need for esoteric notations or conventions: all of us are nowadays using IDEs to help us tell static, pointers, constants and the rest apart.
@@ Line 86: / Line 87: @@
+        }
+    }
 === Use the native capitalization convention for the language you are using ===

← Older revision		Revision as of 13:19, 3 January 2016
Line 39:		Line 39:

	=== Proposing a New Rule ===		=== Proposing a New Rule ===
		+	Write to the [[#The_Good_Dictators\|dictators]] explaining your proposal, along with the reasons associated to it. It will be much appreciated.

	== Design ==		== Design ==

@@ Line 81: / Line 81: @@
         public void myMethod() {
-            // something goes here
+           int methodVariable = 0;
+        }
+    }