Update README.md

README.md

@@ -107,4 +107,26 @@ TODO: Add repos
 The Data Collection and Preprocessing for this Hugging Face dataset involved two main steps.
 First, GitHub repositories known for high code quality were downloaded and labeled as highly readable. The extracted methods are labeled with a score of 4.5.
 Second, the code was intentionally manipulated to reduce readability. The resulting code was labelled with a score of 1.5.
-This resulted in an automatically generated training dataset for source code readability classification.
+This resulted in an automatically generated training dataset for source code readability classification.
+
+#### Who are the source data producers?
+
+The source data producers are the people that wrote the used open source Java projects.
+
+#### Personal and Sensitive Information
+
+The ratings of the code snippets are automatically assigned. Thus, no personal or sensitive information is contained in this dataset.
+
+## Bias, Risks, and Limitations
+
+The assigned labels are not accurate, as they are only an estimation. 
+
+### Recommendations
+
+The dataset should be used to train Java code readability classifiers. We recommend fine-tuning and evaluation on manually labelled data.
+
+## Dataset Card Authors
+Lukas Krodinger, [Chair of Software Engineering II](https://www.fim.uni-passau.de/en/chair-for-software-engineering-ii), [University of Passau](https://www.uni-passau.de/en/).
+
+## Dataset Card Contact
+Feel free to contact me via [E-Mail](mailto:[email protected]) if you have any questions or remarks.