Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.67 KB

README.md

File metadata and controls

65 lines (38 loc) · 2.67 KB
Raw

BernieApp

Build Status

Mobile application for getting involved and keeping up with Bernie.

Tracker backlog: https://www.pivotaltracker.com/n/projects/1414740

Invision mocks: https://projects.invisionapp.com/share/CK3ZHEGWU

Slack channel (you can request access here): https://codersforsanders.slack.com/messages/bernie-app/details/

Setting up build environment

This app will compile with Xcode 7.0. It is bootstrapped using Carthage for project file purity reasons.

Install carthage

Via Homebrew:

  • $ brew install carthage

Install dependencies

  • $ cd src/berniesanders && carthage bootstrap --platform ios

You should now be able to run tests in Xcode by lightly depressing the key combination "⌘+u"

Contributing

Making changes

In order to make changes, you need to get your development environment set up, make your changes on a fork of the BernieiOS repository and then issue a pull request. Please follow the advice below to ensure that your contribution will be readily accepted.

Make your changes

  • Create a branch for your changes (optional, but highly encouraged)
  • Write tests for your changes
  • Make your tests pass by implementing your changes
  • Ensure all tests still pass
  • Push your changes up to your fork at github

Make a pull request

When you have finished making your changes and testing them, go to your forked repo on github and issue a pull request for the branch containing your changes. Please keep in mind the following before submitting your pull request:

  • We favor pull requests with very small, single commits with a single purpose. If you have many changes, they'll be more readily received as separate pull requests
  • Please include tests. They help us understand your intent and prevent future changes from breaking your work. Changes without tests are usually ignored
  • Please ensure all tests pass before making a pull request. Your contribution shouldn't break the app for other users
  • Please ensure all trailing whitespace characters are removed from your changes.

You may find the rake task am_i_done_yet helpful with regards to this. Please note that this requires the installation of swiftlint:

$ brew install swiftlint

The rake task itself can be run by issuing the following command:

$ rake am_i_done_yet

This will check for uncommitted changes, remove trailing white space, unfocus the specs and finally run the specs. It will inform you if your code looks good-to-go!