Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 2.18 KB

Do’s and Don’ts

  • Search tickets before you file a new one. Add to tickets if you have new information about the issue.
  • Only file tickets about the CocoaPods tool itself. This includes CocoaPods, CocoaPods/Core, and Xcodeproj. If your question is regarding a library (to be) distributed through CocoaPods, refer to the spec repo. If your question is “How do I […]”, then please ask on StackOverflow or our mailing-list.
  • Keep tickets short but sweet. Make sure you include all the context needed to solve the issue. Don't overdo it. Great tickets allow us to focus on solving problems instead of discussing them.
  • Take care of your ticket. When you spend time to report a ticket with care we'll enjoy fixing it for you.

Bug reports

First check if you are using the latest CocoaPods version before filing a ticket. You can install the latest version with $ [sudo] gem install cocoapods.

Please include all relevant information, including the version of CocoaPods and any template printed by the tool.

If questions in the error template are left unanswered, the issue will be closed as a bad bug report.

If there is a regression in the projects generated by CocoaPods please include the output (redacted if needed) of one of the following commands:

$ xcodeproj target-diff
$ xcodeproj project-diff

If you are familiar with Ruby, making a pull request with a failing test case can speed up the resolution of the bug. If the issue is more complex you can add an integration test which doesn't require any ruby knowledge.

Feature requests

Please try to be precise about the proposed outcome of the feature and how it would related to existing features.

Pull Requests

We love pull requests and if a contribution is significant we tend to offer push access.

All contributions will be licenced under the MIT license.