📝 Write a CONTRIBUTING file with contributing guidelines

.gitignore

@@ -125,4 +125,4 @@ dmypy.json
 .vscode
 
 # Sublime text
-*.sublime-workspace
+*.sublime-workspace

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# OpenCodeBlocks - Contributing guide
+
+[![Pytest badge](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-tests.yml/badge.svg?branch=master)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-tests.yml) [![Pylint badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_pylint_badge.json)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-pylint.yml) [![Unit coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_unit_coverage_badge.json)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-coverage.yml) [![Integration coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_integration_coverage_badge.json)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-coverage.yml)
+
+Whenever you encounter a :bug: **bug** or have :tada: **feature request**, 
+report this via [GitHub issues](https://github.com/MathisFederico/OpenCodeBlocks/issues).
+
+We are happy to receive contributions in the form of **pull requests** via GitHub.
+
+Feel free to fork the repository, implement your changes and create a merge request to the **dev** branch.
+
+## Getting started
+
+First, make sure you have `python` installed. You will need to install all the `requirements` and the `requirements-dev` using the following commands: 
+
+* `pip install -r requirements.txt`
+* `pip install -r requirements-dev.txt`
+
+You can run the program with `python main.py`
+
+Before doing your **pull request**, check using `pylint` and `pytest` that there were no code regressions.
+
+```bash
+pylint .\opencodeblocks\
+```
+
+```bash
+pytest --cov=opencodeblocks --cov-report=html tests/unit
+```
+
+We want to keep the *Pylint* score above *9.0*.
+
+## Git Commit Messages
+
+Commits should start with a Capital letter and should be written in present tense (e.g. ``:tada: Add cool new feature`` instead of ``:tada: Added cool new feature``).
+You should also start your commit message with one or two applicable emoji. This does not only look great but also makes you rethink what to add to a commit. Make many but small commits!
+
+
+ Emoji           | Description
+-----------------|-------------
+:tada: `:tada:`  | When you add a cool new feature
+:bug: `:bug:`    | When you fixed a bug
+:fire: `:fire:`  | When you removed something
+:truck: `:truck:`| When you moved/renamed something
+:wrench: `:wrench:`     | When you improved/refactored a small piece of code
+:hammer: `:hammer:`     | When you improved/refactored a large piece of code
+:sparkles: `:sparkles:` | When you improved code quality (pylint, PEP, ...)
+:art: `:art:`           | When you improved/added design assets
+:rocket: `:rocket:`     | When you improved performance.
+:memo: `:memo:`         | When you wrote documentation.
+:umbrella: `:umbrella:` | When you improved coverage
+:twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you merge a branch
+
+This section was inspired by [This repository](https://github.com/schneegans/dynamic-badges-action).
+
+## Version Numbers
+
+Version numbers will be assigned according to the [Semantic Versioning](https://semver.org/) scheme.
+This means, given a version number MAJOR.MINOR.PATCH, we will increment the:
+
+1. MAJOR version when we make incompatible API changes,
+2. MINOR version when we add functionality in a backwards compatible manner, and
+3. PATCH version when we make backwards compatible bug fixes.

README.md

@@ -0,0 +1,46 @@
+# OpenCodeBlocks
+
+[![Pytest badge](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-tests.yml/badge.svg?branch=master)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-tests.yml)
+[![Pylint badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_pylint_badge.json)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-pylint.yml)
+[![Unit coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_unit_coverage_badge.json)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-coverage.yml)
+[![Integration coverage badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FMathisFederico%2F00ce73155619a4544884ca6d251954b3%2Fraw%2Fopencodeblocks_integration_coverage_badge.json)](https://github.com/MathisFederico/OpenCodeBlocks/actions/workflows/python-coverage.yml)
+[![Licence - GPLv3](https://img.shields.io/github/license/MathisFederico/Crafting?style=plastic)](https://www.gnu.org/licenses/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
+
+OpenCodeBlocks is an open-source tool for modular visual programing in python.
+
+## Features
+
+* Put your python code in small independent blocks
+* Export and Import your blocks and share them with other people
+* Chain your blocks to perform complex functions.
+
+## Installation
+
+Make sure you have Python 3 installed. You can download it from [here](https://www.python.org/downloads/)
+
+Clone the current repo:
+
+```bash
+git clone https://github.com/MathisFederico/OpenCodeBlocks/
+```
+
+Install the dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+Run !
+
+```bash
+python ./main.py
+```
+
+## Contributing
+
+If you are interested in contributing to the project, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+See [LICENSE](LICENSE)