Skip to content
Snippets Groups Projects
CONTRIBUTING.md 3.31 KiB
Newer Older
emelko's avatar
emelko committed
# Contributing to drip aka CONDRIPUTING
bl00dymarie's avatar
bl00dymarie committed
So good to see you here, hello :wave\_tone1: :wave\_tone2: :wave\_tone3: :wave\_tone4: :wave\_tone5:
bl00dymarie's avatar
bl00dymarie committed


## Table Of Contents

bl00dymarie's avatar
bl00dymarie committed
[TL;DR](#tl-dr)

bl00dymarie's avatar
bl00dymarie committed
[What should I know before I get started?](#what-should-i-know-before-i-get-started)

emelko's avatar
emelko committed
[How can I condripute?](#how-can-i-condripute)
bl00dymarie's avatar
bl00dymarie committed
[Thank you](#thank-you)

bl00dymarie's avatar
bl00dymarie committed
## TL;DR

bl00dymarie's avatar
bl00dymarie committed
You just want to say hello? Send us a [nice email](mailto:drip@mailbox.org?Subject=Nice%20incoming%20mail) :postbox:, ask to [join our Slack](mailto:drip@mailbox.org?Subject=Join%20Slack) or tweet :bird: at us [@dripberlin](https://twitter.com/dripberlin).
bl00dymarie's avatar
bl00dymarie committed
## What should I know before I get started?

bl00dymarie's avatar
bl00dymarie committed
We have prepared something for **you**: check out our [README](https://gitlab.com/bloodyhealth/drip/blob/master/README.md) for more information on how to set up and install everything you'll need.
bl00dymarie's avatar
bl00dymarie committed
[Ping us](mailto:drip@mailbox.org) if you could need some help :helmet\_with\_cross: !
bl00dymarie's avatar
bl00dymarie committed
Let us know if you want to suggest improvements for the README and open a merge request (which is just like Github's pull request)
emelko's avatar
emelko committed
## How can I condripute?
emelko's avatar
emelko committed
### Your First Code Condripution
bl00dymarie's avatar
bl00dymarie committed

We are fans of labels, at least for our issues. You can find a list of `newbie` issues [here](https://gitlab.com/bloodyhealth/drip/issues?label_name%5B%5D=Newbie).
bl00dymarie's avatar
bl00dymarie committed
If you decide to work on an issue, please click on `Create branch` based on that issue. You can find this as a dropdown option right under `Create merge request`.
This allows us to keep track of the issues that are related to an existing branch and tells everyone "somebody is working on it".
bl00dymarie's avatar
bl00dymarie committed
If you want to open a merge request, yeah :tada: exciting! We are using a template for merge requests to make sure we explain what we have done and why.
bl00dymarie's avatar
bl00dymarie committed
Keep in mind that people who will review your merge request are more motivated to do so when the merge request is well explained and ideally not too big.
bl00dymarie's avatar
bl00dymarie committed
### Reporting Bugs
bl00dymarie's avatar
bl00dymarie committed
You found a bug :bug:? Please feel free to investigate and save logs for more specific details.
bl00dymarie's avatar
bl00dymarie committed
Before creating a new issue, please review the [list of existing issues](https://gitlab.com/bloodyhealth/drip/issues) to make sure the bug is unknown. You are invited to describe the bug in all its details e.g. in what context/settings has it occurred?
bl00dymarie's avatar
bl00dymarie committed
To send us a new issue you can also use our [gitlab email](mailto:incoming+bloodyhealth/drip@incoming.gitlab.com). It will automagically add a new issue to the list with a description text taken from the body of your email.
bl00dymarie's avatar
bl00dymarie committed

### Suggesting Enhancements

Do you have suggestions for enhancing the app or for cleaning up some code? Fantastic!
bl00dymarie's avatar
bl00dymarie committed
Before creating a new issue, please review the [list of existing issues](https://gitlab.com/bloodyhealth/drip/issues) to make sure nobody else had the same idea before you! You are then invited to open a new issue with a somewhat extensive description, you can use emojis or GIFs if it helps :)!
bl00dymarie's avatar
bl00dymarie committed
To send us a new issue you can also use our [gitlab email](mailto:incoming+bloodyhealth/drip@incoming.gitlab.com). It will automagically add a new issue to the list with the title taken from the subject line and the description text for the issue taken from the body of your email.
bl00dymarie's avatar
bl00dymarie committed

### Thank you

![](https://media.giphy.com/media/kPA88elN9kYco/giphy.gif)
emelko's avatar
emelko committed
Thank you for condriputing to open source, thank you for condriputing to drip!
bl00dymarie's avatar
bl00dymarie committed
Much love from Bloody Health :heart\_exclamation: