RACCommunity

Note: These guidelines take heavy inspiration from RxSwiftCommunity and Moya. Thank you for raising the bar on how Open Source collaboration should be!

First of all, let me thank you for taking the time to read this! These days, it's very difficult to find time to do anything. So if you are reading this, it's probably because you are interested in contributing to the amazing community around ReactiveCocoa. If you are not, you are welcomed anyway!

What's RACCommunity?

RACComunity serves as an umbrella organization for projects that use ReactiveCocoa. These projects, can have different goals:

1. Demonstrate how to use ReactiveCocoa (e.g. RACNest).
2. Wrap another library or framework (e.g ReactiveAlamofire).
3. Create a component powered by ReactiveCocoa (e.g. Reactor, Rex)

These projects will benefit from the expertise of the ReactiveCocoa core members:

1. When a new ReactiveCocoa version is released, the projects will be updated as soon as possible.
2. When an issue is open, we will try to help as much as we can.
3. Bug fixes! Most often than not, these can be ilusive for people not used to ReactiveCocoa particularities.
4. Make sure they respect ReactiveCocoa design guidelines.

Having a striving community around is not only important, but critical for its survival. Above all, RACommunity aims to be a fun place, where your work and dedication is meaningful!

What's in for you?

The best answer for this would be Samuel Giddins's "An OSS education".

Contributing Guidelines

Our guidelines are simple and quite straightforward!

1. If you have an idea for a new project, independently of you wanting to do it yourself, or just wanting it built, open an issue.
2. If we all think your idea makes sense, we will create a new repository so you can work on it. When you land your first meaningful PR, we will give you membership. Creating a PR for the first time can be daunting! Fear not, If there is any problem, we will discuss it and find a solution.
3. Your work should always be peer reviewed (via a PR). Pushing directly to master, it's not something you should do.
4. If you are not sure how to progress, or what want to discuss any issue in "real time", you can always use our Slack! Ping @ReactiveCocoa if you need an invite.
5. Any contribution is a good contribution. From a bug fix, documentation or a typo, please make yourself at home! We all know tho, that sometimes, we just want to build new stuff, but we are unsure how. For those cases, we will label tasks as good first step (this idea was taken from Moya).
6. There also the cases when you already have a project and would like to see it under the RACCommunity org. For those cases, start by opening an issue. Once we all have agreed it makes sense, the project ownership is transfered and you will receive a membership invitation.

As a Community member...

• ... you can review a PR from any project and merge it (as long as it's not your own). If there is something wrong with the PR and it got merged, it will just be reverted. Don't worry!
• ... contribute and move forward the projects!
• ... if you have an idea for a new project, open an issue, so it can be discussed by everyone.
• ... have fun!

Code expectations

1. Use Github's Swift code styling. If it's not specified in the guide, check ReactiveCocoa source code and follow the same approach.
2. Code should be unit tested.
3. If the project is a dependency, it should be CocoaPods and Carthage compatible.

Code of Conduct

We follow the Contributor Covenant version 1.4.0.

Questions?

Talk with us on Slack (Ping @ReactiveCocoa if you need an invite) or open an issue!