aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorTomáš Znamenáček2015-01-26 09:43:47 +0100
committerTomáš Znamenáček2015-01-26 09:43:47 +0100
commit345da61b0d2b111d6184532c4e37891bdc3de411 (patch)
tree61cf9b322528e698a4eea990a262a45cfc4be1a5 /CONTRIBUTING.md
parentfd6885abdb15a8306f0130c42cca421df3b19bee (diff)
downloadMASShortcut-345da61b0d2b111d6184532c4e37891bdc3de411.tar.bz2
Added a short release guide.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..9f53769
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# 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).
+
+Then update the `CHANGES` file. Add information about the new version (see the previous versions for an example) and add the release date.
+
+Now commit the changes:
+
+ $ git commit -a -m "Version bump to x.y.z."
+
+And tag the last commit:
+
+ $ git tag -a x.y.z
+
+Now push both the commits and tags (`--tags`) to GitHub and push the new podspec to CocoaPods:
+
+ $ pod trunk push MASShortcut.podspec
+
+This will run sanity checks on the podspec and fail if the spec does not validate.
+
+That’s it. Go have a beer or a cup of tea to celebrate. \ No newline at end of file