Update README.md

README.md

@@ -1,45 +1,175 @@
 ---
 dataset_info:
   features:
-  - name: id
-    dtype: string
-  - name: number
-    dtype: int64
-  - name: title
-    dtype: string
-  - name: body
-    dtype: string
-  - name: state
-    dtype: string
-  - name: createdAt
-    dtype: timestamp[s]
-  - name: updatedAt
-    dtype: timestamp[s]
-  - name: closedAt
-    dtype: timestamp[s]
-  - name: url
-    dtype: string
-  - name: author
-    struct:
-    - name: login
+    - name: id
       dtype: string
-  - name: labels
-    struct:
-    - name: nodes
-      list:
-      - name: name
-        dtype: string
-  - name: comments
-    list: string
+
+    - name: number
+      dtype: int64
+
+    - name: title
+      dtype: string
+
+    - name: body
+      dtype: string
+
+    - name: state
+      dtype: string
+
+    - name: createdAt
+      dtype: timestamp[s]
+
+    - name: updatedAt
+      dtype: timestamp[s]
+
+    - name: closedAt
+      dtype: timestamp[s]
+
+    - name: url
+      dtype: string
+
+    - name: author
+      struct:
+        - name: login
+          dtype: string
+
+    - name: labels
+      struct:
+        - name: nodes
+          list:
+            - name: name
+              dtype: string
+
+    - name: comments
+      list: string
+
   splits:
-  - name: train
-    num_bytes: 12467615
-    num_examples: 3343
-  download_size: 5416086
-  dataset_size: 12467615
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+    - name: train
+      num_bytes: 12467615
+      num_examples: 3343
+      download_size: 5416086
+      dataset_size: 12467615
+
+  configs:
+    - config_name: default
+      data_files:
+        - split: train
+          path: data/train-*
+---
+
+# GitHub Issues Dataset
+
+## Dataset Description
+
+The **GitHub Issues Dataset** is a collection of publicly
+available GitHub issues collected from the
+[Hugging Face `datasets` repository](https://github.com/huggingface/datasets).
+
+Each example represents a GitHub issue and contains information
+such as the issue identifier, issue number, title, description,
+state, timestamps, author, labels, original URL, and comments.
+
+The dataset was collected using the GitHub GraphQL API with
+cursor-based pagination.
+
+The dataset is intended for research and experimentation in
+Natural Language Processing (NLP), software engineering,
+information retrieval, semantic search, issue analysis,
+question answering, and Large Language Models (LLMs).
+
+---
+
+## Dataset Details
+
+- **Source:** Hugging Face `datasets` repository
+- **Source platform:** GitHub
+- **Domain:** Software development
+- **Language:** Primarily English
+- **Data type:** Text and structured metadata
+- **Number of examples:** 3,343
+- **Format:** Parquet / Arrow
+- **Split:** `train`
+
+---
+
+## Source
+
+The original data was collected from the public GitHub repository:
+
+https://github.com/huggingface/datasets
+
+The original issues are available through the GitHub Issues
+section of the repository.
+
+---
+
+## Data Collection
+
+The dataset was collected through the GitHub GraphQL API.
+
+Cursor-based pagination was used to retrieve issues from the
+repository.
+
+For each issue, the following information was collected:
+
+- Issue ID
+- Issue number
+- Title
+- Body
+- State
+- Creation timestamp
+- Update timestamp
+- Closing timestamp
+- Original GitHub URL
+- Author login
+- Labels
+- Comments
+
+Only publicly accessible information was collected.
+
+---
+
+## Dataset Structure
+
+Each example contains the following fields:
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | string | Unique GitHub identifier for the issue |
+| `number` | int64 | GitHub issue number |
+| `title` | string | Title of the issue |
+| `body` | string | Main description and content of the issue |
+| `state` | string | Current issue state, such as `OPEN` or `CLOSED` |
+| `createdAt` | timestamp | Date and time when the issue was created |
+| `updatedAt` | timestamp | Date and time when the issue was last updated |
+| `closedAt` | timestamp | Date and time when the issue was closed, if applicable |
+| `url` | string | Original GitHub issue URL |
+| `author` | struct | Information about the issue author |
+| `labels` | struct | Labels assigned to the issue |
+| `comments` | list[string] | Comments associated with the issue |
+
 ---
+
+## Example
+
+A simplified example of a dataset record:
+
+```json
+{
+  "id": "I_kwDODunzps8AAAABMjWDaQ",
+  "number": 8475,
+  "title": "Dataset.select raises a raw OverflowError on in-range negative indices",
+  "body": "Describe the bug ...",
+  "state": "OPEN",
+  "createdAt": "2026-08-13T03:02:44",
+  "updatedAt": "2026-08-13T03:02:44",
+  "closedAt": null,
+  "url": "https://github.com/huggingface/datasets/issues/8475",
+  "author": {
+    "login": "codeAnqiang-ma"
+  },
+  "labels": {
+    "nodes": []
+  },
+  "comments": []
+}