Merge remote-tracking branch 'origin/dev' into refactor/window

.gitlab/issue_templates/Bug.md

@@ -0,0 +1,45 @@
+<!---
+Please read this!
+
+Before opening a new issue, make sure to search for keywords in the issues
+filtered by the "Regression" or "Bug" label:
+
+https://gitlab.com/aimber/ScreenPlay/issues?label_name%5B%5D=Bug
+https://gitlab.com/aimber/ScreenPlay/issues?label_name%5B%5D=Regression
+
+
+Verify the issue you're about to submit isn't a duplicate.
+--->
+
+### Summary
+
+(Summarize the bug encountered concisely)
+
+### Steps to reproduce
+
+(How one can reproduce the issue - this is very important)
+
+### Example Project
+
+(If possible, please create an example project here on GitLab.com that exhibits the problematic behaviour, and link to it here in the bug report)
+
+(If you are using an older version of ScreenPlay, this will also determine whether the bug has been fixed in a more recent version)
+
+### What is the current *bug* behavior?
+
+(What actually happens)
+
+### What is the expected *correct* behavior?
+
+(What you should see instead)
+
+### Relevant logs and/or screenshots
+
+(Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code as it's very hard to read otherwise.)
+
+### Possible fixes
+
+(If you can, link to the line of code that might be responsible for the problem)
+
+/label ~Bug

.gitlab/issue_templates/Feature.md

@@ -0,0 +1,34 @@
+<!---
+Please read this!
+
+Before opening a new issue, make sure to search for keywords in the feature
+filtered by the "Feature"  label:
+
+https://gitlab.com/aimber/ScreenPlay/issues?label_name%5B%5D=Feature
+
+
+Verify the feature you're about to submit isn't a duplicate.
+--->
+
+
+### Problem to solve
+
+<!-- What problem do we solve? Keep it short like a TL:DR-->
+
+### Further details
+
+<!-- Include use cases, benefits, and/or goals (contributes to our vision?) -->
+
+### Proposal
+
+<!-- How are we going to solve the problem? Try to include the user journey! https://about.gitlab.com/handbook/journeys/#user-journey -->
+
+
+### What does success look like, and how can we measure that?
+
+<!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. -->
+
+
+### Links / references
+
+/label ~Feature

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing to ScreenPlay
+
+### Basic
+
+Every changes to ScreenPlay are done via Gitlab issues and merge requests (pull request for github people). These follow the normal contributing pattern: press the big blue fork button at the top of the repository, make changes, open a merge request.
+
+### Development
+
+1.  Accept the [Contributing Agreement](https://gitlab.com/aimber/ScreenPlay).
+2.  Download and set up ScreenPlay as described in the main [Readme](https://gitlab.com/aimber/ScreenPlay).
+2.  Choose an issue to work on:
+    *   Your own ideas or thinks you want to improve. Alternatively you can tackle existing open issues:
+    *   You can find simple problems by [searching for problems labeled "Accepting merge requests" sorted by weight.](https://gitlab.com/aimber/ScreenPlay/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=0&sort=weight). Low-weight issues will be the easiest to accomplish.
+    *   Make sure that no one else is working on the problem and make sure that we are still interested in a particular post.
+    *   You can also make comments and ask for help if you are new or stuck. We will be happy to help you!
+3.  Add the feature or fix the bug you’ve chosen to work on.
+4.  Open a merge request to merge your code and its documentation (preferably via [draw.io]( http://draw.io/) embedded graphs). The sooner you open a merge request, the sooner you can get feedback. You can mark it as Work in Progress to indicate that you are not finished.
+6.  Make sure the CI builds are passing.
+7.  Make sure to update the translations if you've added any text via the qsTr("text) macro. It is ok to not translate your text for all the supported languages. You can always ask other contributors from other countries to verify your translations.
+7.  Wait for a reviewer. You’ll likely need to change some things once the reviewer has completed a code review for your merge request. You may also need multiple reviews depending on the size of the change.
+8.  Get your changes merged!
+
+
+### Programming rules
+
+1.  Use the Qt naming conventions for [C++](https://wiki.qt.io/Coding_Conventions) and [QML](https://doc.qt.io/qt-5/qml-codingconventions.html)
+2.  Use all the available Qt container and classes for things like (Q)Strings and (Q)Vector.
+3.  Use the c++17 std smart pointer.
+4.  Use the webkit formatting style. You can automatically format your code via the Beautifier QtCreator plugin:
+    *   To activate this plugin you have to navigate inside your QtCreator: Help -> About Plugins -> Beautifier. 
+    *   [Download and install LLVM](http://releases.llvm.org/download.html) to format the code
+    *   In QtCreator navigate to: Tools -> Options -> Beautifier -> Clang format -> Options -> Use predefined style: Webkit
+    *   Add a formatting shortcut via: Tools -> Options -> Environment -> Keyboard -> Search for "format" and add your shortcut to ClangFormat, FormatFile
+3.  Use this [git commit message style](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53)
+
+### Documentation
+
+To contribute to the [documentation](https://aimber.gitlab.io/ScreenPlayDocs/) you only have to press the pen icon on the top right of every page. We mostly use [draw.io]( http://draw.io/) for every diagram because it is free and you can embed the code inside a png when exporting the document. 
+
+### Translation
+
+We use the [Qt Linguist] for translating ScreenPlay. This tool lets you open the ScreenPlay_<language>.ts files and edit these easily. If is included in the open source Qt SDK and normally inside your Qt bin folder: "C:\Qt\5.XX.0\msvc2017_64\bin\linguist.exe" 
+
+### Design
+
+To design ScreenPlay we use [Affinity Designer](https://affinity.serif.com/en-gb/designer/) as superior alternative to Photoshop. But you can use any tool you like. If you have any ideas on how to improve any design aspect of ScreenPlay just open a issue with the "Design" tag and paste you mockups into the description (preferably as png or/and the source *.afdesign file) 

README.md

@@ -12,7 +12,9 @@ Join our community: <a href="https://screen-play.app/">Homepage</a>, <a href="ht
 </div>
 <br>
 
+## Contributing
 
+Everyone can contribute with code, design, documentation or translation. Visit our [contributing guide](https://gitlab.com/aimber/ScreenPlay/blob/dev/CONTRIBUTING.md) for more informations.
 
 # Getting started