diff --git a/CHANGELOG.md b/CHANGELOG.md index fbe554c..a870980 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,9 @@ All notable changes to this project will be documented in this file. - Added by [William Entriken](https://github.com/fulldecent) - Full API documentation with headerdoc - Added by [William Entriken](https://github.com/fulldecent) +- Contributing guidelines and release process documentation + - Added by [William Entriken](https://github.com/fulldecent) in regards to issue + [#93](https://github.com/fulldecent/FDBarGuage/issues/93). #### Fixed - Crash of the iPad example when present from window is tapped diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1b7f9eb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing + +All contributors are welcome. Please use issues and pull requests to contribute to the project. And update [CHANGELOG.md](CHANGELOG.md) when committing. + +# Release Process + +1. Confirm the build is passing in travis + 1. This automatically checks the pod file is building +2. Create a release commit, see [prior releases](https://github.com/fulldecent/FDTake/releases) for an example + 1. Update the change log to label the latest improvements under the new version name + 2. Update the podspec version number +3. Tag the release in GitHub + 1. Create the release commit + 2. Create the release with notes from the change log +3. Push the podspec to cocoapods + 1. `pod trunk push` +4. Create Carthage binaries + 1. `carthage build --no-skip-current` + 2. `carthage archive FDBarGuage` + 3. Add to the GitHub release