-
-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add changelog and contibuting, fixes #1
- Loading branch information
1 parent
9a031a7
commit 1b1f6d2
Showing
3 changed files
with
42 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Change Log | ||
All notable changes to this project will be documented in this file. | ||
`__PROJECT_NAME__` adheres to [Semantic Versioning](http://semver.org/). | ||
|
||
## [Master](https://github.com/__GITHUB_USERNAME__/__PROJECT_NAME__) | ||
### Added | ||
|
||
### Changed | ||
|
||
### Removed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Contributing | ||
|
||
All contributors are welcome. Please use issues and pull requests to contribute to the project. And update [CHANGELOG.md](CHANGELOG.md) when committing. | ||
|
||
## Making a Change | ||
|
||
When you commit a change, please add a note to [CHANGELOG.md](CHANGELOG.md). | ||
|
||
## Release Process | ||
|
||
1. Confirm the build is [passing in travis](https://travis-ci.org/__GITHUB_USERNAME__/__PROJECT_NAME__) | ||
1. This automatically checks the Podfile is building | ||
2. Push a release commit | ||
1. Create a new Master section at the top | ||
2. Rename the old Master section like: | ||
## [1.0.5](https://github.com/__GITHUB_USERNAME__/__PROJECT_NAME__/releases/tag/1.0.5) | ||
Released on 2016-02-14. | ||
3. Update the Podspec version number | ||
3. Create a GitHub release | ||
1. Tag the release (like `1.0.5`) | ||
2. Paste notes from [CHANGELOG.md](CHANGELOG.md) | ||
3. Push the Podspec to CocoaPods | ||
1. `pod trunk push` | ||
4. Create Carthage binaries | ||
1. `carthage build --no-skip-current` | ||
2. `carthage archive __PROJECT_NAME__` | ||
3. Add to the GitHub release |