Updated Version Policy (markdown)
authorerikarn <adrian.chadd@gmail.com>
Thu, 4 Apr 2013 00:01:43 +0000 (17:01 -0700)
committererikarn <adrian.chadd@gmail.com>
Thu, 4 Apr 2013 00:01:43 +0000 (17:01 -0700)
Version-Policy.md

index b81f53502ed3f4f9329119d83216c1db457748ae..d58907b3e922a4f11706f127ed19676abb4f5514 100644 (file)
@@ -1,4 +1,4 @@
-= Why do we need a versioning policy? =
+## Why do we need a versioning policy?
 
 Why? Because it's firmware and it's not tightly coupled to the driver.
 
@@ -6,11 +6,13 @@ The firmware will be used by various projects for NIC support. It's not just for
 
 Since some downstream projects may wish to fork the github repository and do some of their own local development, each major and minor release will be a branch.
 
+## Ok, what's the policy?
+
 The policy is thus:
 
-* No non-backwards compatible changes will occur on a major branch;
-* Minor version numbers may introduce new features but they must be optional and default to the previous firmware behaviour;
-* Major branch numbers may introduce non-backwards-compatible features.
+1. No non-backwards compatible changes will occur on a major branch;
+2. Minor version numbers may introduce new features but they must be optional and default to the previous firmware behaviour;
+3. Major branch numbers may introduce non-backwards-compatible features.
 
 So: