Skip to content

Latest commit

 

History

History
111 lines (83 loc) · 4.43 KB

CONTRIBUTING.md

File metadata and controls

111 lines (83 loc) · 4.43 KB
Raw

Table of Contents generated with DocToc

Welcome to Quick!

We're building a testing framework for a new generation of Swift and Objective-C developers.

Quick should be easy to use and easy to maintain. Let's keep things simple and well-tested.

Reporting Bugs

Nothing is off-limits. If you're having a problem, we want to hear about it.

  • See a crash? File an issue.
  • Code isn't compiling, but you don't know why? Sounds like you should submit a new issue, bud.
  • Went to the kitchen, only to forget why you went in the first place? Better submit an issue.

Be sure to include in your issue:

  • Your Xcode version (eg - Xcode 7.0.1 7A1001)
  • Your version of Quick / Nimble (eg - v0.7.0 or git sha 7d0b8c21357839a8c5228863b77faecf709254a9)
  • What are the steps to reproduce this issue?
  • What platform are you using? (eg - OS X, iOS, watchOS, tvOS)
  • If the problem is on a UI Testing Bundle, Unit Testing Bundle, or some other target configuration
  • Are you using Carthage or CocoaPods?

Building the Project

  • After cloning the repository, run git submodule update --init to pull the Nimble submodule.
  • Use Quick.xcworkspace to work on Quick. The workspace includes Nimble, which is used in Quick's tests.

Pull Requests

  • Nothing is trivial. Submit pull requests for anything: typos, whitespace, you name it.
  • Not all pull requests will be merged, but all will be acknowledged. If no one has provided feedback on your request, ping one of the owners by name.
  • Make sure your pull request includes any necessary updates to the README or other documentation.
  • Be sure the unit tests for both the OS X and iOS targets of both Quick and Nimble pass before submitting your pull request. You can run all the iOS and OS X unit tests using rake.
  • The main branch will always support the stable Xcode version. Other branches will point to their corresponding versions they support.
  • If you're making a configuration change, make sure to edit both the xcode project and the podspec file.

Style Conventions

  • Indent using 4 spaces.
  • Keep lines 100 characters or shorter. Break long statements into shorter ones over multiple lines.
  • In Objective-C, use #pragma mark - to mark public, internal, protocol, and superclass methods. See QuickSpec.m for an example.

Core Members

If a few of your pull requests have been merged, and you'd like a controlling stake in the project, file an issue asking for write access to the repository.

Your conduct as a core member is your own responsibility, but here are some "ground rules":

  • Feel free to push whatever you want to main, and (if you have ownership permissions) to create any repositories you'd like.

    Ideally, however, all changes should be submitted as GitHub pull requests. No one should merge their own pull request, unless no other core members respond for at least a few days.

    Pull requests should be issued from personal forks. The Quick repo should be reserved for long-running feature branches.

    If you'd like to create a new repository, it'd be nice if you created a GitHub issue and gathered some feedback first.

  • It'd be awesome if you could review, provide feedback on, and close issues or pull requests submitted to the project. Please provide kind, constructive feedback. Please don't be sarcastic or snarky.

Read CODE_OF_CONDUCT.md for more in depth guidelines.

Creating a Release

The process is relatively straight forward, but here's is a useful checklist for tagging:

  • Look at changes from the previously tagged release and write release notes: git log v0.4.0...HEAD
  • Run the release script: ./script/release A.B.C release-notes-file
  • The script will prompt you to create a new GitHub release.
    • Use the same release notes you created for the tag, but tweak up formatting for GitHub.
  • Announce!