Skip to content

Files

Latest commit

94e908c · Apr 10, 2016

History

History
44 lines (31 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.83 KB

Contributing

All contributions are welcomed for this project! Nothing is off limits.

If you found a problem, file an issue.

If you just want to contribute, feel free to look through the issues list, or simply submit a PR with your idea!

Reporting Bugs

As swift evolves, this project may become out date. Feel free to file issues to report problems. Be sure to include:

  • What platform are you building for? (eg - iOS 9.3, Xcode 7.3)
  • What package manager are you using? (eg - Cocoapods 0.39.0)
    • Swift Package Manager based on what version of swift you're using
    • Cocoapods version can be retrieved via: pod --version
    • Carthage version can be retrieved via: carthage version
  • What is your target configuration? (iOS App, OS X Framework, etc.)

Pull Requests

Please try to minimize the amount of commits in your pull request. The goal is to keep the history readable.

Always rebase your changes onto master before submitting your PR's.

Please write good commit messages:

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how

If you need to modify/squash existing commits you've made, use rebase interactive.

If your PR includes Objective-C code, please apply clang-format to it. You can use the awesome ClangFormat-Xcode plugin to make it easier.