Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
bcylin committed Jun 23, 2017
1 parent 1b92249 commit cebbf80
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Feedback

We'd love the feedback from you. Please create [GitHub Issues](https://github.com/carousell/pickle/issues) for feature discussions, bug reports and anything you'd like us to know. Be sure to check out the [closed issues](https://github.com/carousell/pickle/issues?q=is:closed) before you open new ones.

## Contributing

1. Fork the repo.

2. Create a local feature branch from the latest `master`, prefix it with **feature/** and use **hyphen-separated-words** to name your branch:

```sh
git checkout -b feature/your-branch
```

3. Add your changes and push it to your fork

4. Create a pull request

## Dependencies

CocoaPods is used to set up the example project. Follow the [instruction](https://guides.cocoapods.org/using/getting-started.html#installation) to install it before you set up the project by running `make bootstrap`.

**Pickle** uses Ruby 2.3.4 and [Bundler](http://bundler.io/) to manage dependencies on Travis CI. It's not required locally. However if you have Ruby environment set up, additional tools are specified in the [Gemfile](https://github.com/carousell/pickle/blob/master/Gemfile).
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Follow the [instructions](https://github.com/Carthage/Carthage#adding-frameworks
github "carousell/pickle" ~> 1.0.0
```

## Development
## Example

Install [CocoaPods](https://guides.cocoapods.org/using/getting-started.html#installation):

Expand All @@ -128,15 +128,19 @@ gem install cocoapods

Set up the development pods:

```shell
```sh
pod install --project-directory=Example && open Example/Pickle.xcworkspace
```

## Contributing

Thank you for being interested in contributing to this project. Check out the [CONTRIBUTING](https://github.com/carousell/pickle/blob/master/CONTRIBUTING.md) document for more info.

## About

<a href="https://github.com/carousell/" target="_blank"><img src="https://avatars2.githubusercontent.com/u/3833591" width="100px" alt="Carousell" align="right"/></a>

**Pickle** is created and maintained by [Carousell](https://carousell.com/). Help us improve this project! We'd love to hear your [feedback](https://github.com/carousell/pickle/issues).
**Pickle** is created and maintained by [Carousell](https://carousell.com/). Help us improve this project! We'd love the [feedback](https://github.com/carousell/pickle/issues) from you.

We're hiring! Find out more at <http://careers.carousell.com/>

Expand Down

0 comments on commit cebbf80

Please sign in to comment.