CONTRIBUTING.md

Contributing to 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
• Pull requests
• Creating issues
• 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 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

  • 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
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 as a template for this file.