This repository has been archived by the owner on Nov 3, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 284
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #256 from CocoaPods/contributing
Create CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
## Bug Reports | ||
|
||
In short, since you are most likely a developer, provide a ticket that you _yourself_ would _like_ to receive. | ||
|
||
Please include steps to reproduce and _all_ other relevant information, including the | ||
version of CocoaPods.app. | ||
|
||
## Feature Requests | ||
|
||
Please try to be precise about the proposed outcome of the feature and how it | ||
would related to existing features. | ||
|
||
From the [CocoaPods blog](https://blog.cocoapods.org/CocoaPods-0.28/): | ||
|
||
> Fighting feature creep in CocoaPods is not easy. We hear about a lot of great ideas and many of them don't make the cut as they would not be useful for at least 80% of our users. | ||
## Pull Requests | ||
|
||
We **love** pull requests and if a contribution is significant we tend to offer | ||
push access. | ||
|
||
All contributions _will_ be licensed under the MIT license. | ||
|
||
Code/comments should adhere to the following rules: | ||
|
||
* Names should be descriptive and concise. | ||
* When writing comments, use properly constructed sentences, including | ||
punctuation. | ||
* When documenting APIs and/or source code, don't make assumptions or make | ||
implications about race, gender, religion, political orientation or anything | ||
else that isn't relevant to the project. | ||
* Remember that source code usually gets written once and read often: ensure | ||
the reader doesn't have to make guesses. Make sure that the purpose and inner | ||
logic are either obvious to a reasonably skilled professional, or add a | ||
comment that explains it. | ||
* The message of the commit should be prefixed by the name of the file which is | ||
the main focus of the patch enclosed by square brackets (.e.g. `[Installer] | ||
install pods`). |