white-rabbit-apps / communikitty-ios

The CommuniKitty app for iOS with Swift 3
0 stars 1 forks source link

White Rabbit iOS App

This is a template app, which will be able to build multiple apps with the same core features in the future, but is starting with the CommuniKitty app first.

Contributing

Target

When doing development, please always use the "CommuniKitty Dev" target. This is connected to a dev server so you can add all the data you want without affecting the production data. Please avoid using the "CommuniKitty" target for testing and especially avoid creating any dummy posts with dummy text in the data to keep production data clean and valid.

Branching

When working on an issue, please create a new branch with a name that follows this format:

'[issue_number]-[your_github_username]-[issue_name]'

This should follow the convention of all other branches in the repository so follow those.

Commenting

Please always comment your code as much as possible, including SwiftDoc [http://nshipster.com/swift-documentation/] style comments for functions and inline comments especially for code that may be confusing for someone else down the line.

/**
Lorem ipsum dolor sit amet.

- Parameters:
    - bat: Faulta nominus hereet.
    - bar: Consectetur adipisicing elit.

- returns: Sed do eiusmod tempor.
*/
func foo(bat: String, bar: String) -> AnyObject { ... }

A lot of the legacy code still needs to be updated with comments, which will happen, but please comment as much as possible from now on.

Committing

Please prefix all commit messages with the issue number so that the commit is attached to the issue in github. Use the following format:

#XXX - commit message

Pull Requests

When you're done with the issue, please make a pull request to the master branch and I will evaluate, merge, and close the issue, or let you know what should be changed.

Pod Changes

When making changes to a pod library, changes can be made to the source files in the pod directory while developing the change, but needs to be moved to a forked version of the library to finalize the changes. That forked repo can then be referenced from the Podfile. Please contact me about forking a new project into the git group account.

Technologies

Languages

Compiling Assets from Sketch

python Tools/Slicer/slice.py "Design/iPhone.sketch" "White Rabbit/Assets.xcassets" python Tools/Slicer/slice.py "../../../design/iPhone_new.sketch" "White Rabbit/AssetsNew.xcassets"

Frameworks|Tools Used

Frameworks|Tools To Consider