Improve small details and add information about repositories

README.md

@@ -72,9 +72,9 @@ configs:
   - split: test
     path: commitchronicle-py-long-labels/test-*
 ---
-# LCA (CMG)
+# 🏟️ Long Code Arena (Commit Message Generation)
 
-This is the data for CMG benchmark as part of LCA.
+This is the benchmark for Commit Message Generation task as part of 🏟️ Long Code Arena benchmark.
 
 ## How-to
 
@@ -96,12 +96,16 @@ This is the data for CMG benchmark as part of LCA.
     dataset = load_dataset("JetBrains-Research/lca-cmg", configuration, split="test")
     ```
 
-    Some notes:
-      * All the data we have is considered to be in test split
+    Note that all the data we have is considered to be inthe  test split.
+
+**Note.** Working with git repositories under [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory is not supported via 🤗 Datasets. Download and extract the contents of each repository. We provide a full list of files in [`paths.json`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/blob/main/paths.json).
 
 ## Dataset Structure
 
-This dataset contains two kinds of data: either *full data* about each commit (including modifications) or metadata with quality *labels*.
+This dataset contains three kinds of data: 
+* *full data* about each commit (including modifications)
+* metadata with quality *labels*
+* compressed *git repositories*
 
 
 ### Full data
@@ -126,7 +130,7 @@ We consider two possible commit modifications formats:
 
 Currently, only [CommitChronicle](https://huggingface.co/datasets/JetBrains-Research/commit-chronicle) is considered as an input source, so only the first commit modifications format is used.
 
-### List of diffs (CommitChronicle)
+#### List of diffs (CommitChronicle)
 
 Data point example:
 
@@ -176,4 +180,8 @@ Data point example:
  'message': 'Add auto_id_policy and logs_path flags\n\nThese changes were introduced in the 1.7.5 SDK.',
  'label': 1,
  'comment': 'no way to know the version'}
-```
+```
+
+### Git Repositories
+
+This section concerns [`repos`](https://huggingface.co/datasets/JetBrains-Research/lca-cmg/tree/main/repos) directory, which stores compressed Git repositories for all the commits in this benchmark. After you download and extract it, you can work with each repository either via Git or via Python libraries like [GitPython](https://github.com/gitpython-developers/GitPython) or [PyDriller](https://github.com/ishepard/pydriller).