aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomáš Znamenáček2015-08-18 17:23:09 +0200
committerTomáš Znamenáček2015-08-18 17:23:09 +0200
commit86be6257cbbec1dd04e1fd641031c55cd8503046 (patch)
tree97ecacdb8ea14b237025d65669d165441f37223d
parent9f5db7ad257bafa7e4887199d844ca0aacad5f66 (diff)
downloadMASShortcut-86be6257cbbec1dd04e1fd641031c55cd8503046.tar.bz2
Updated contributing guidelines (backward compatibility, commit messages).
-rw-r--r--CONTRIBUTING.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9f53769..70fa9c1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,11 @@
+# Backward Compatibility
+
+Please note that this framework supports older OS X versions down to 10.6. When changing the code, be careful not to call any API functions not available in 10.6 or call them conditionally, only where supported.
+
+# Commit Messages
+
+Please use descriptive commit message. As an example, _Bug fix_ commit message doesn’t say much, while _Fixed a memory-management bug in formatting code_ works much better.
+
# How to Release a New Version
First, update the version numbers. (MASShortcut uses [Semantic Versioning](http://semver.org/), so please read the docs if you’re not sure what the deal is.) The version number is stored in `Framework/Info.plist` and `MASShortcut.podspec` (twice in both files).