Make sure you've read the README file in this repo.
Observe uses protocol oriented programming so always start with a protocol then create classes, structs, and enums after.
If you find a bug, a spelling mistake, or anything you don't like, submit an issue.
If you think you have a better way of doing something, submit an issue.
If you would like to add a completely new feature to Observe, submit an issue.
To make any code contributions, you'll have to fork this repo and keep your version synced with this repo. Read this article if you need some help getting started.
We are using A successful Git branching model so make sure you always sync your repo from the develop
branch and when you're done, pull request back into the develop
branch. This makes it easier to organize code, update changelogs, and add tags and version numbers.
When you want to start coding, create a new feature
branch off of the develop
branch. You should name this banch feature/name-of-feature
.
Before writing any code or making any commits, make sure to check out the Styleguides section of this document.
Use TDD and make sure that all code has test coverage.
Copy the style of code used in project. That goes for writing tests and production code. I should not be able to test your code apart from mine or anyone else's.
Once you have completed you're code. Pull request your code into the develop
branch of this repo.
Use [the seven rules of a great git commit message] (http://chris.beams.io/posts/git-commit/) when committing.
Refer to this swift styleguide for how you should write your swift code.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to sam@meech-ward.me.