This repository has been archived by the owner on Jul 9, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
68 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters