Skip to content

Latest commit

 

History

History
21 lines (11 loc) · 3.71 KB

CONTRIBUTING.md

File metadata and controls

21 lines (11 loc) · 3.71 KB

Hello dear contributor 👋 We are happy to have you on board!

Let's have a quick overview about how you can help to make this project better for all. We are just starting with this and we like to keep things as simple as possible. On the other side, we also need to make sure, that we can handle the maintainer job without too much time investment because most of us doing this as a side gig and not for a living.

At this point, we have set up these simple rules that we ask you to follow. Thank you. 👇

Please fork this repo and do not simply clone it

The reason for this is, that with a fork you get full control over your copy of the original repository under your own account on GitHub. This means that you can simply push any changes you made on your code up to your remote repo. If you use a clone of the original repository, this would only be possible, if you were a registered contributor with write access to the original repo. This does not affect your option to submit a pull request (PR) to have your changes merged into the main branch (our production branch) of the original repo. In this YT Video, you can have a good introduction to the difference between a fork and a clone.

👉 Fork vs. Git Clone: What's the Difference? https://youtu.be/6YQxkxw8nhEGit

Please open an issue before creating a pull request

We like to have a clean process for pull requests and therefore we ask you to always open an issue before submitting your PR. We know that many people might disagree with this practice and find it cumbersome or disruptive. Asking you to do this will prevent duplicate work from our valued contributors. If you always check the issues first, before even starting to work on a contribution, this makes sure, that you don't waste your precious time. This is a mandatory prerequisite to get your PR approved. Please notice, that we will assign every issue to a contributor who then owns the right to submit a corresponding pull request. PR's submitted from contributors that are not the assignee of a corresponding issue will not get approved, other than the assignee lacks of doing the work in a reasonable time. We hope you can live with this and we thank you for your understanding.

Please notice - GitHub discussions and Wiki

Our goal is to preserve the discussions of our community in a manner, that supports us to keep full control over our data. By hosting this project on GitHub we miss this goal, because these informations are stored on a centralized, company owned system. That in itself is not necessarily a bad thing. Nonetheless it is a vendor and, or, platform lock in. As recent events around different company owned services have brought to our all awareness, it could be possible to have to move to another solution with a project. Something that we want to prevent as far as possible. To no longer disrupt the progress of this idea, we accept the risk and keep this project at this place. To say it loud and clear, I personally like GitHub, but I still am also considered about owning my data. What does that even mean? Well, the issues and discussion features of GitHub are a good thing. There is nothing wrong in using them. It is our goal and philosophy to not being locked in to any particular vendor or platform. In any case, we don't want to lose the discussions and questions and answers that make an essential part of this shared knowledge repository. We work on a communication and messaging strategy. That is why we keep the discussions and the wiki options of GitHub disabled. The evaluation of the place and form for wiki and, or, documentation is open. You are invited to open an issue or to comment, report a bug, or propose a change or feature. 🤝

We are working on it. Please be patient. Thank you! 💚