Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Massage the CONTRIBUTIONS file a bit.

  • Loading branch information...
commit 6da6af96fed887ad41fc86cbbde0a24e0dc7849c 1 parent f05721c
@alloy alloy authored
Showing with 20 additions and 10 deletions.
  1. +20 −10 CONTRIBUTING.md
View
30 CONTRIBUTING.md
@@ -1,21 +1,31 @@
# Contributing
+Before creating a issue or pull-request, be sure to search for existing tickets
+first and provide additional feedback on those instead.
+
## Issues
-The issues of this repository refer only to the development of the tool. Other
-resources are:
+The issues of this repository refer **only** to the development of the CocoaPods
+tool. These resources include:
+
+- [CocoaPods](https://github.com/CocoaPods/CocoaPods/issues)
+- [CocoaPods/Core](https://github.com/CocoaPods/Core/issues)
+- [Xcodeproj](https://github.com/CocoaPods/Xcodeproj/issues)
+
+Please refer to these other resources for things unrelated to the tool itself:
-- [CocoaPods/Specs](https://github.com/CocoaPods/Specs): Submit new Pods and
- report broken ones.
- [Mailing List](http://groups.google.com/group/cocoapods): Usage & general
questions.
+- [CocoaPods/Specs](https://github.com/CocoaPods/Specs/issues): Submit new Pods and
+ report broken ones.
Properly written and formatted issues are more likely to receive the
-appropriate attention. If you don't care... we don't care.
+appropriate attention. Or, as we say at Keeping-Sanity-in-OSS-HQ™: _“If you don’t care, we won’t care.”_
+
#### Bug reports
-Please post all the relevant information including the version of CocoaPods and
+Please include _all_ relevant information, including the version of CocoaPods and
any template printed by the tool.
If there is a regression in the projects generated by CocoaPods please include
@@ -35,13 +45,13 @@ 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 with the existing ones.
+would related to existing features.
+
## Pull Requests
-We love pull requests and if a contribution is significative we tend to offer
+We **love** pull requests and if a contribution is significant we tend to offer
push access.
-All the contributions are intended to be licenced under the MIT license by
-their respective authors.
+All contributions will be licenced under the MIT license.
Please sign in to comment.
Something went wrong with that request. Please try again.