Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing instructions #704

Merged
merged 2 commits into from
Mar 23, 2018
Merged

Update contributing instructions #704

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f57af91
Update contributing instructions
funkyboy Mar 19, 2018
4aa87f5
Update release instructions
funkyboy Mar 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,12 +563,14 @@ You can also view the [community reported Github issues](https://github.com/ably

## Contributing

In this repo the `master` branch contains the latest stable version of the Ably SDK. Pushing changes to the `master` branch is locked. All the development (bug fixing, feature implementation, etc.) is done against the `develop` branch, which you should branch from whenever you'd like to make modifications. Here's the steps to follow when contributing to this repo.

1. Fork it
2. Install dependencies by running `pod install` and `carthage bootstrap`
3. Create your feature branch (`git checkout -b my-new-feature`)
3. Create your feature branch from `develop` (`git checkout develop && git checkout -b my-new-feature-branch`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Ensure you have added suitable tests and the test suite is passing
6. Push to the branch (`git push origin my-new-feature`)
6. Push to the branch (`git push origin my-new-feature-branch`)
7. Create a new Pull Request

## Running tests
Expand All @@ -579,9 +581,13 @@ The project supports fastlane. To run tests use `fastlane scan --scheme "Ably"`.

This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:

* Create a new branch `release-x.x.x` (where `x.x.x` is the new version number) from the `develop` branch
* Run script `./Scripts/set-version.sh x.x.x` to assign the new version number.
* Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the CHANGELOG has completed, manually change the `Unreleased` heading and link with the current version number such as `v1.0.0`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Commit this change.
* Push tag to origin such as `git push origin x.x.x`.
* Make a PR against `develop`
* Wait for review. Once the PR is approved, merge it into `develop`
* Fast-forward the master branch: `git checkout master && git merge --ff-only develop`
* Visit [releases page](https://github.com/ably/ably-ios/releases) and `Add release notes`.
* Release an update for CocoaPods: `(pod lib lint && pod trunk push Ably.podspec)`.
* Generate the prebuilt framework for Carthage (`(carthage build --no-skip-current && carthage archive Ably)`) and attach the zip file to the release.
Expand Down