dirien · dirien · Aug 9, 2021 · Aug 9, 2021
@@ -0,0 +1,58 @@
+# Contributing to minectl 🗺
+
+Welcome, and thank you for considering contributing to minectl 🗺. We encourage you to help out by raising issues,
+improving documentation, fixing bugs, or adding new features
+
+If you're interested in contributing please start by reading this document.
+
+## Establishing a Development Environment
+
+Establishing a development environment typically requires:
+
+1. Forking and cloning the repository.
+1. Installing development dependencies.
+
+## Contributing Code
+
+To contribute bug fixes or features to minectl 🗺:
+
+1. Communicate your intent.
+1. Make your changes.
+1. Test your changes.
+1. Update documentation and examples.
+1. Open a Pull Request (PR).
+
+Communicating your intent lets the minectl 🗺 maintainers know that you intend to contribute, and how. This sets you up
+for success - you can avoid duplicating an effort that may already be underway, adding a feature that may be rejected,
+or heading down a path that you would be steered away from at review time. The best way to communicate your intent is
+via a detailed GitHub issue. Take a look first to see if there's already an issue relating to the thing you'd like to
+contribute. If there isn't, please raise a new one! Let us know what you'd like to work on, and why.
+
+Be sure to practice [good git commit hygiene] as you make your changes. All but the smallest changes should be broken up
+into a few commits that tell a story. Use your git commits to provide context for the folks who will review PR, and the
+folks who will be spelunking the codebase in the months and years to come. Ensure each of your commits is signed-off in
+compliance with the [Developer Certificate of Origin] by using `git commit -s`.
+
+All minectl 🗺 documentation and examples are under revision control; see the
+[docs] and [config] directories of this repository. Any change that introduces new behaviour or changes
+existing behaviour must include updates to any relevant documentation and examples. Please keep documentation and
+example changes in distinct commits.
+
+In summary, please:
+
+* Discuss your change in a GitHub issue before you start.
+* Use your Git commit messages to communicate your intent to your reviewers.
+* Sign-off on all Git commits by running `git commit -s`
+* Add or update tests for all changes.
+* Update all relevant documentation and examples.
+* If necessary, tidy up your git commit history once your PR is approved.
+
+Thank you for reading through our contributing guide!
+
+[good git commit hygiene]: https://www.futurelearn.com/info/blog/telling-stories-with-your-git-history
+
+[Developer Certificate of Origin]: https://github.com/apps/dco
+
+[docs]: docs/
+
+[config]: config/
@@ -0,0 +1,36 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
@@ -52,7 +52,6 @@
 ![Vultr](https://img.shields.io/badge/vultr-007BFC?style=for-the-badge&logo=vultr&logoColor=white)
 ![Microsoft Azure](https://img.shields.io/badge/Microsoft--Azure-0078D4?style=for-the-badge&logo=microsoft-azure&logoColor=white)
 
-
 ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/dirien/minectl/Build%20Binary/main?logo=github&style=for-the-badge)
 ![GitHub](https://img.shields.io/github/license/dirien/minectl?style=for-the-badge)
 
@@ -86,6 +85,10 @@ brew install minectl
 Linux or Windows user, can directly download (or use `curl`/`wget`) the binary via
 the [release page](https://github.com/dirien/minectl/releases).
 
+### Architectural overview
+
+You can find a high level architectural overview [here](docs/architecture.md)
+
 ### Usage ⚙
 
 #### Access Token 🔑
@@ -565,7 +568,7 @@ Apache License, Version 2.0
 - [x] Add modded versions as new edition [#20](https://github.com/dirien/minectl/issues/20)
 - [x] New cloud provider - Vultr [#90](https://github.com/dirien/minectl/issues/90)
 - [x] Add Suport for Proxy Server - bungeecord and waterfall [#95](https://github.com/dirien/minectl/issues/95)
-- [x] New cloud provider - Azure [#56](https://github.com/dirien/minectl/issues/56)  
+- [x] New cloud provider - Azure [#56](https://github.com/dirien/minectl/issues/56)
 - [ ] ...
 
 ### Libraries & Tools 🔥

@@ -0,0 +1,11 @@
+# minectl 🗺 Architecture diagram
+
+The architecture of minectl is quite straight forward:
+
+![img.png](img/architecture.png)
+
+With the help of different types of cloud provider implementations, we are able to translate a MinecraftSever or
+MinecraftProxy manifest into a running VM instance.
+
+Several Ports where exposed in the is process, where the Server or Proxy port is the minimum. If the User wants to
+expose a monitoring on top, he can enable this in the manifest files.