Improve code quality

Author: ckittl

CHANGELOG.md

@@ -4,9 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - 2020-11-05
+## **0.1.0** - 2020-11-05
 
 ### Added
--   Basic input and output handling for grid models provided by csv files following the specifications of [PowerSystemDataModel](https://raw.githubusercontent.com/ie3-institute/PowerSystemDataModel) - up to version XXX
+-   Basic input and output handling for grid models provided by csv files following the specifications of [PowerSystemDataModel](https://raw.githubusercontent.com/ie3-institute/PowerSystemDataModel) - up to version 1.3.2
 -   Visualisation of the grid model including system participants (e.g. loads, pv plants, ...)
 -   Basic editing functionality (Renaming, moving around nodes to alter their geographical position, ...)

CONTRIBUTING.md

@@ -4,14 +4,14 @@ And thank you for considering your contribution to this project!
 With this document we would like to give you some orientation on how you can contribute.
 
 ## Table of contents
-* [Testing and reporting bugs](#testing-and-reporting-bugs)
-* [Suggest extensions](#suggest-extensions)
-* [Contributing code](#contributing-code)
-* [Branching and handing in pull requests](#branching-and-handing-in-pull-requests)
-* [General (software) design guidelines](#general-software-design-guidelines)
-* [Testing](#testing)
-* [Finalising your pull request](#finalising-your-pull-request)
-* [For any doubts](#for-any-doubts)
+*   [Testing and reporting bugs](#testing-and-reporting-bugs)
+*   [Suggest extensions](#suggest-extensions)
+*   [Contributing code](#contributing-code)
+*   [Branching and handing in pull requests](#branching-and-handing-in-pull-requests)
+*   [General (software) design guidelines](#general-software-design-guidelines)
+*   [Testing](#testing)
+*   [Finalising your pull request](#finalising-your-pull-request)
+*   [For any doubts](#for-any-doubts)
 
 ## Testing and reporting bugs
 We really appreciate your usage of this project.
@@ -20,22 +20,22 @@ Until now we have a good lack of high level documentation, therefore please chec
 If not, please raise one for us.
 Considering the following aspects in your inquiry, assists us in helping you:
 
-* **Is there already an issue addressing your problem?**
-* Try to **locate the error** as precise as possible.
-* What has to be done to **reproduce the error**?
-* **Provide stack trace, logs etc.** and further helpful information
-* **What would do you expect to happen?**
-* Mark the issue with the **label _bug_**.
+*   **Is there already an issue addressing your problem?**
+*   Try to **locate the error** as precise as possible.
+*   What has to be done to **reproduce the error**?
+*   **Provide stack trace, logs etc.** and further helpful information
+*   **What would do you expect to happen?**
+*   Mark the issue with the **label _bug_**.
 
 ## Suggest extensions
 We use issues as well to keep track of enhancement suggestions.
 Considering the following aspects, assists us in understanding your needs properly:
 
-* **Is there already an issue addressing your request?**
-* **What would do you desire for?**
-* If possible provide an **example or sketch**.
-* Show a **use case**, that should be as versatile as possible.
-* Mark the issue with the **label _enhancement_**.
+*   **Is there already an issue addressing your request?**
+*   **What would do you desire for?**
+*   If possible provide an **example or sketch**.
+*   Show a **use case**, that should be as versatile as possible.
+*   Mark the issue with the **label _enhancement_**.
 
 ## Contributing code
 If you intend to produce some lines of code, pick an issue and get some hands on!
@@ -49,9 +49,9 @@ Before opening it for review, please [finalise your pull request](#finalising-yo
 ### General (software) design guidelines
 In order to maintain a consistent project, we thought of some general design guidlines, we kindly ask you to take care of:
 
-* We :heart: **immutability**. Therefore, please don't provide setters and use proper instantiation instead.
-* `double a = b * pow(x, j)`? :hand: Please **be expressive** in what you code!
-* Document your code with **javadoc**.
+*   We :heart: **immutability**. Therefore, please don't provide setters and use proper instantiation instead.
+*   `double a = b * pow(x, j)`? :hand: Please **be expressive** in what you code!
+*   Document your code with **javadoc**.
 
 ### Testing
 Ensure the proper function of your code by [test driven development (TDD)](https://www.guru99.com/test-driven-development.html).
@@ -61,14 +61,14 @@ We have good experiences using [Spock](http://spockframework.org/) as a testing
 Some automated checks assist us in delivering a pretty fair quality of software.
 Before marking the pull request as 'ready to review', take these precautionary actions:
 
-* Are all tests passing? Run `gradle test`
-* Is your code properly formatted? Run `gradle spotlessApply`
+*   Are all tests passing? Run `gradle test`
+*   Is your code properly formatted? Run `gradle spotlessApply`
 
 `gradle finalizePR` summarizes all of these steps .
 
 ## For any doubts
 ... please contact
-* [Johannes (@johanneshiry)](https://github.com/johanneshiry) or
-* [Chris (@ckittl)](https://github.com/ckittl)
+*   [Johannes (@johanneshiry)](https://github.com/johanneshiry) or
+*   [Chris (@ckittl)](https://github.com/ckittl)
 
 We are happy to help! :smiley: