Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

31 lines (17 loc) · 1.82 KB

Contributing

We love getting contributions to the app, in any form. If you're interested in committing code, read on. For bug reports, feel free to look through the existing list of issues and add your own if it's not already there, using the BUG template. Feature requests can also go there using the RFE template. For more general questions or to discuss ideas for features try the Beeminder Forum.

Legal Schmegal

Before contributing code, please read and sign beeminder.com/cla.

Set up

See Getting Started for instructions on how to get the app running locally on XCode.

Development flow

We follow the GitHub flow conventions for development.

We recommend forking to your own repository as the first step. Add your repository as a remote named origin and add this repository (beeminder/BeeSwift) as a remote named upstream.

To start work on a new feature/bug fix, make a branch off of master.

git checkout -b branch-name-here --no-track upstream/master

Before submitting a pull request, rebase your work off the current master branch.

We have a (currently very limited) suite of tests set up on Semaphore CI. Pull requests that add to the test suite are very welcome and encouraged! Submitting a pull request from your fork will trigger a build on Semaphore. If the pull request looks good and everything is green on Semaphore, the PR will be merged after a review.

Deployment

We have Fastlane set up to manage uploading builds to TestFlight and the App Store and tagging commits as appropriate.