From 86be6257cbbec1dd04e1fd641031c55cd8503046 Mon Sep 17 00:00:00 2001 From: Tomáš Znamenáček Date: Tue, 18 Aug 2015 17:23:09 +0200 Subject: Updated contributing guidelines (backward compatibility, commit messages). --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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). -- cgit v1.2.3