Sha256: 607d83650a95ce23602770e5aa80ae17ba024e7ca377181933017b469e014d4a

Contents?: true

Size: 1.95 KB

Versions: 3

Compression:

Stored size: 1.95 KB

Contents

# Contribute

## Introduction

First, thank you for considering contributing to the Karafka ecosystem! It's people like you that make the open source community such a great community! 😊

We welcome any type of contribution, not only code. You can help with:
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
- **Marketing**: writing blog posts, howto's, printing stickers, ...
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
- **Code**: take a look at the [open issues](issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.

## Your First Contribution

Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).

## Submitting code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

### Code review process

Each pull request must pass all the rspec specs and meet our quality requirements.

To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.

### Contributing to Pro components

All of Karafka components are open-source. However, the `Pro` components are licenses under `LICENSE-COMM`.

By sending a pull request to the pro components, you are agreeing to transfer the copyright of your code to Maciej Mensfeld.

## Questions

If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!).
You can also reach us at hello@karafka.opencollective.com.

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
karafka-2.0.0.rc3 CONTRIBUTING.md
karafka-2.0.0.rc2 CONTRIBUTING.md
karafka-2.0.0.rc1 CONTRIBUTING.md