Skip to content

Commit

Permalink
Add changelog and contibuting, fixes #1
Browse files Browse the repository at this point in the history
  • Loading branch information
fulldecent committed Sep 16, 2016
1 parent 9a031a7 commit 1b1f6d2
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 3 deletions.
8 changes: 5 additions & 3 deletions Recipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,8 @@ Complete all these instructions on the same calendar day.

cd ~/Desktop/__PROJECT_NAME__/
curl 'https://raw.githubusercontent.com/github/gitignore/master/Swift.gitignore' -o .gitignore
curl 'https://raw.githubusercontent.com/github/gitignore/master/.travis.yml' -o .travis.yml
curl 'https://raw.githubusercontent.com/github/gitignore/master/LICENSE' -o LICENSE
curl 'https://raw.githubusercontent.com/github/gitignore/master/README.md' -o README.md
curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/.travis.yml' -o .travis.yml
curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/LICENSE' -o LICENSE
curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/README.md' -o README.md
curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/CHANGELOG.md' -o CHANGELOG.md
curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/CONTRIBUTING.md' -o CONTRIBUTING.md
10 changes: 10 additions & 0 deletions __PROJECT_NAME__/CHANGELOG.md
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
27 changes: 27 additions & 0 deletions __PROJECT_NAME__/CONTRIBUTING.md
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

0 comments on commit 1b1f6d2

Please sign in to comment.