Merge pull request #149 from kristovatlas/develop

v1.0.0

CONTRIBUTING.md

@@ -2,18 +2,18 @@
 
 This project uses a Gitflow-like organization for code:
 
-* The `master` branch represents a stable version of the project at any given time.
-* Releases are tags on the `master` branch.
-* All features and bug fixes are performed against the `develop` branch.
-* New features are allocated their own branch based on the `develop` branch, and pull requests are made from the new feature branch to the `develop` branch.
+* The [`master`](https://github.com/kristovatlas/osx-config-check/tree/master) branch represents a stable version of the project at any given time.
+* Releases are tags on the [`master`](https://github.com/kristovatlas/osx-config-check/tree/master) branch.
+* All features and bug fixes are performed against the [`develop`](https://github.com/kristovatlas/osx-config-check/tree/develop) branch.
+* New features are allocated their own branch based on the [`develop`](https://github.com/kristovatlas/osx-config-check/tree/develop) branch, and pull requests are made from the new feature branch to the [`develop`](https://github.com/kristovatlas/osx-config-check/tree/develop) branch.
 
 Developers who wish to submit a pull request should perform the following protocol:
 
 1. Fork the project on GitHub
-2. Create a special-purpose branch from the `develop` branch, e.g. 'fix-filevault' or 'disable-apple-mail'
+2. Create a special-purpose branch from the [`develop`](https://github.com/kristovatlas/osx-config-check/tree/develop) branch, e.g. 'fix-filevault' or 'disable-apple-mail'
 3. Implement the changes in the branch
 4. Follow the guidelines in the sections below depending on whether you are modifying configuration checks, Python code, or any combination therefore
-5. Make a pull request from your feature branch to the `develop` branch. 
+5. Make a pull request from your feature branch to the [`develop`](https://github.com/kristovatlas/osx-config-check/tree/develop) branch.
 
 ## Modifying default configuration checks
 
@@ -42,3 +42,18 @@ To "install" this pre-commit hook, copy it to the `.git/hooks` directory contain
 ## Modifying Python files
 
 You SHOULD use `pylint` on any Python files you modify before submitting your modifications. Please attempt to avoid lowering the `pylint` score of these files.
+
+## Versioning
+
+The osx-config-check project aims to use [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
+
+1. A major version number is incremented when an incompatible change is made either to the Hjson syntax for a config check or when an incompatible change is made to api.sh functions (e.g. a function is removed or its prototype modified).
+2. A minor version number is incremented when a feature is added that is backwards-compatible, including:
+  * A new element is added to the Hjson syntax that is compatible with existing config checks
+  * A new function is added to api.sh
+3. A patch version number is incremented when a bug is fixed in a backward-compatible way, including:
+  * Changes to bash commands
+  * Changes to the contents of scripts
+  * Typos in code or documentation
+
+New versions are produced by merging stable changes from the [`develop`](https://github.com/kristovatlas/osx-config-check/tree/develop) branch to the [`master`](https://github.com/kristovatlas/osx-config-check/tree/master) branch, and by tagging them as a new release.