Update README.md

README.md

@@ -47,13 +47,14 @@ dataset_info:
   dataset_size: 1500130634
 task_categories:
 - text-generation
+- summarization
 language:
 - en
 tags:
 - code
 pretty_name: Github issues dataset
 size_categories:
-- 10K<n<100K
+- 100K<n<1M
 ---
 
 # GitHub Pull Request Bug–Fix Dataset
@@ -72,63 +73,104 @@ This dataset is designed for:
 
 ---
 
+## How to use
+
+install datasets python library:
+
+```bash
+pip install datasets
+```
+here is a copy paste example
+```python
+from datasets import load_dataset
+
+# Load all splits
+dataset = load_dataset("helloadhavan/github_issues")
+
+print(dataset)
+# pick the train split
+
+example = dataset["train"][0]
+
+# Inspect a single example
+
+print("Repository:", example["repo"])
+print("Buggy commit:", example["buggy_commit"])
+print("Fix commit:", example["fix_commit"])
+print("Message:", example["message"])
+print("Timestamp:", example["timestamp"])
+
+print("\nModified files:")
+for f in example["files"]:
+    print("-", f["path"], f["language"])
+
+# Filter examples by programming language
+
+def contains_assembly_file(example):
+    return any(f["language"] == "Assembly" for f in example["files"])
+
+python_fixes = dataset["train"].filter(contains_assembly_file)
+
+print("Assembly-related fixes:", len(python_fixes))
+
+```
+
+
 ## Data collection methodology
 
-Data was collected using the **GitHub REST API** and post-processed into a structured format.
+Data was collected from **GitHub repositories** by identifying commit pairs that represent
+a **bug-introducing version** and its corresponding **fix commit**.
 
-To maintain quality and usefulness:
+The dataset was constructed and post-processed to ensure high signal and usability:
 
-- Only **merged pull requests** were included
-- Each PR must represent a **bug fix or correctness change**
-- Fixes are linked to both the **buggy commit** and the **fix commit**
-- Code changes are stored as **unified diffs** at the file level
-- Low-signal PRs (refactors, formatting-only changes, discussions) were filtered out
-- PRs without meaningful code changes were excluded
+- Only commits representing **bug fixes or correctness changes** were included
+- Each example explicitly links a **buggy commit** to the corresponding **fix commit**
+- Repository metadata is preserved for traceability
+- Code changes are stored as **unified diffs at the file level**
+- Commits that only perform refactoring, formatting, or non-functional changes were excluded
+- Entries without meaningful code changes were filtered out
 
-Each dataset row represents **one bug–fix PR**.
+Each dataset row represents **one bug–fix commit pair**, rather than a pull request.
 
 ---
 
 ## Dataset schema
 
-Each entry follows the schema below:
+Each entry in the dataset follows the schema below:
 
 ```json
 {
   "repo": "owner/repository",
-  "pr_number": 12345,
-  "title": "Short description of the fix",
-  "body": "Pull request description and context",
   "buggy_commit": "abcdef123456...",
   "fix_commit": "fedcba654321...",
-  "buggy_distance": 12,
-  "confidence": "medium",
+  "message": "Commit message describing the fix",
+  "timestamp": "YYYY-MM-DDTHH:MM:SSZ",
   "files": [
     {
-      "filename": "path/to/file.ext",
+      "path": "path/to/file.ext",
       "patch": "unified diff representing the fix",
       "additions": 10,
-      "deletions": 2
+      "deletions": 2,
+      "language": "Programming language inferred from file extension"
     }
   ]
 }
 ```
 
-| Field               | Description                                       |
-| ------------------- | ------------------------------------------------- |
-| `repo`              | GitHub repository containing the pull request     |
-| `pr_number`         | Pull request number                               |
-| `title`             | Pull request title                                |
-| `body`              | Pull request description and discussion context   |
-| `buggy_commit`      | Commit introducing or containing the bug          |
-| `fix_commit`        | Commit that fixes the bug                         |
-| `buggy_distance`    | Number of commits between buggy and fix commits   |
-| `confidence`        | Heuristic confidence level of bug–fix correctness |
-| `files`             | List of files modified by the fix                 |
-| `files[].filename`  | Path to the modified file                         |
-| `files[].patch`     | Unified diff containing the code changes          |
-| `files[].additions` | Number of lines added                             |
-| `files[].deletions` | Number of lines removed                           |
+| Field               | Description                                           |
+| ------------------- | ----------------------------------------------------- |
+| `repo`              | GitHub repository containing the fix                  |
+| `buggy_commit`      | Commit introducing or containing the bug              |
+| `fix_commit`        | Commit that fixes the bug                             |
+| `message`           | Commit message associated with the fix                |
+| `timestamp`         | Timestamp of the fix commit (ISO 8601 format)         |
+| `files`             | List of files modified by the fix                     |
+| `files[].path`      | Path to the modified file                             |
+| `files[].patch`     | Unified diff containing the code changes              |
+| `files[].additions` | Number of lines added                                 |
+| `files[].deletions` | Number of lines removed                               |
+| `files[].language`  | Programming language inferred from the file extension |
+
 
 ## Supported languages
 
@@ -165,6 +207,15 @@ Buggy commit identification is heuristic and may be imperfect
 Some fixes involve refactoring or design changes rather than minimal patches
 No guarantee that fixes represent optimal or best-practice solutions
 
-> ⚠️ Warning
-This dataset currently includes pull requests from 10 of the planned 25 repositories, totaling approximately 24,000 entries.
-The final release is expected to contain ~50,000 entries and occupy ~2 GB of storage.
+<blockquote
+  style="
+    background: #fff7cc;
+    border-left: 5px solid #ffad00;
+    padding: 12px 16px;
+    color: #5c4b00;
+    font-style: italic;
+    border-radius: 4px;
+  "
+>
+  <strong style="color:rgba(57, 0, 0, 1)">Note:</strong> Due to a bug in the scraper code, 109k samples were collected instead of the planned 50k.
+</blockquote>