diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..70c7340a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# Contributing to [Vaccipy](https://github.com/iamnotturner/vaccipy): +πŸŽ‰ At first, thanks for taking the time to contribute! πŸŽ‰ + +>tbf. + +Hi, we created some guidelines for contributing to Vaccipy. These are +guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + + +### Table of Contents +- [TLDR](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question) +- [Pull requests](#pull-requests) +- [Creating issues](#creating-issues) +- [Reference](#reference) + + + +## General communication +To make sure everybody stays motivated to push this project forward it is really important that we treat each other with respect. +Many people with different skillsets work on this project and only together we've got the chance to create something great. πŸš€ +So please stay calm and be nice to each other. + +Use our [Slack](#we-have-an-official-slack) for communication between developers. + + + +## I don't want to read this whole thing I just have a question!!! + +> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below. + + +#### We have an official Slack: + +* [Join the Vaccipy Slack Team](https://join.slack.com/t/vaccipy/shared_invite/zt-qt5ympiu-j7P86E2U0yM3shqoNSoqyg) + * Use the `#chat` channel for general questions and discussion about Vaccipy + * Use the `#development` channel for more dev related stuff + * Use the `#continous-integration` channel for everything build, deployment, workflow and installer related + * Use the `#gui` channel for everything related to our graphical user interface + * Important announcements will be shared in the `#important` channel + + Even though Slack is a chat service, sometimes it takes several hours for community members to respond — please be patient! + + + +## Pull Requests +1. Please only create pull requests into the [beta branch](https://github.com/iamnotturner/vaccipy/tree/beta) +2. Discribe the purpose of your changes +3. Make sure your code doesn't break stuff. Test your code on the different available os. +4. Test if all pipeline checks passed. +5. Request reviews from one or multiple contributors +6. Squash commits + + +## Creating issues +tbf. + + + +## Reference +I have used the [CONTRIBUTING.md of Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) as a template for this file. diff --git a/README.md b/README.md index 2bc57317..e223a3d7 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,7 @@ pip3 install -r requirements.txt ``` #### Developer Collaboration +Bitte schau einmal in die [CONTRIBUTING.md](https://github.com/iamnotturner/vaccipy/blob/master/CONTRIBUTING.md) FΓΌr direkte Kommunikation kannst du als Entwickler gerne unserem Slack beitreten! @@ -349,14 +350,18 @@ save da world. my final message. goodbye. ### Shoutouts +- [tex.fm: Impftermine-Bot](https://www.tex.fm/blog/2021/06/impftermine-bot) - [DASDING: HOW TO IMPFTERMIN - DIESE TOOLS HELFEN DIR](https://www.dasding.de/update/wie-impftermin-einfacher-bekommen-100.html) - Danke an Dani Rapp! -- [Deutschlandfunk: Portale und Tools sollen bei Suche nach Impfterminen helfen](https://www.deutschlandfunk.de/corona-pandemie-portale-und-tools-sollen-bei-suche-nach.1939.de.html?drn:news_id=1261638) -- [WDR: Per Klick zum Impftermin](https://www1.wdr.de/nachrichten/themen/coronavirus/impftermine-online-buchen-100.html) +- [Deutschlandfunk: Portale und Tools sollen bei Suche nach Impfterminen helfen](https://www.deutschlandfunk.de/corona-pandemie-portale-und-tools-sollen-bei-suche-nach.1939.de.html?drn:news_id=1269109) +- [WDR: Per Klick zum Impftermin](https://www1.wdr.de/nachrichten/themen/coronavirus/impftermine-online-buchen-100.html) - es war einmal... (*sad reacts only*) + + + - +