Update README.md

README.md

@@ -1,41 +1,77 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: int64
-  - name: title
-    dtype: string
-  - name: body
-    dtype: string
-  - name: author
-    dtype: string
-  - name: labels
-    list: string
-  - name: created_at
-    dtype: timestamp[ns, tz=UTC]
-  - name: comments_count
-    dtype: int64
-  - name: url
-    dtype: string
-  - name: year
-    dtype: int32
-  - name: month
-    dtype: int32
-  - name: title_length
-    dtype: int64
-  - name: body_length
-    dtype: int64
-  - name: actual_comments
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 74619
-    num_examples: 40
-  download_size: 48474
-  dataset_size: 74619
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+language: en
+license: mit
+tags:
+- github
+- text
+- issues
+- dataset-creation
+- open-source
 ---
+
+# GitHub Issues Dataset
+
+## Dataset Description
+This dataset contains **100 public GitHub issues** collected from a repository of choice.  
+It includes metadata about each issue, such as the author, creation date, labels, and content, as well as **derived fields** for analysis.
+
+The dataset was created as part of a **Task 1 Assessment** for a data course, demonstrating:
+- API data collection
+- Data augmentation
+- Publishing datasets on Hugging Face Hub
+
+---
+
+## Dataset Features
+
+| Feature Name      | Type                        | Description |
+|------------------|----------------------------|-------------|
+| `id`             | int64                       | Unique identifier of the GitHub issue |
+| `title`          | string                      | Issue title |
+| `body`           | string                      | Full text description of the issue |
+| `author`         | string                      | GitHub username of the issue creator |
+| `labels`         | list of string              | Labels/tags associated with the issue |
+| `created_at`     | timestamp[ns, tz=UTC]      | Date and time the issue was created |
+| `comments_count` | int64                       | Number of comments reported by GitHub API |
+| `url`            | string                      | Direct link to the GitHub issue |
+| `year`           | int32                       | Year extracted from `created_at` |
+| `month`          | int32                       | Month extracted from `created_at` |
+| `title_length`   | int64                       | Number of characters in the title |
+| `body_length`    | int64                       | Number of characters in the body |
+| `actual_comments`| int64                       | Count of comments fetched via API |
+
+---
+
+## Data Collection Method
+- Data was collected using the **GitHub Issues API** (`requests` library in Python).  
+- Only **public issues** were retrieved; no private data or personally identifiable information was included.  
+- **Derived fields** (`year`, `month`, `title_length`, `body_length`) were added for analysis purposes.  
+- `actual_comments` was fetched from the issue comments endpoint to supplement the original `comments_count`.
+
+---
+
+## Licensing
+- Data comes from **public GitHub repositories**, which are governed by GitHub’s Terms of Service.  
+- This dataset itself is released under the **MIT License**, allowing reuse and modification.
+
+---
+
+## Limitations
+- Small sample size: **100 issues only**; not representative of all GitHub repositories.  
+- Possible **labeling bias**, as labels depend on repository maintainer conventions.  
+- Only issues in **English** were collected.  
+- No guarantees on completeness; the dataset may contain truncated issue bodies.
+
+---
+
+## Ethical Considerations
+- Only public data used.  
+- No private, sensitive, or personally identifiable information collected.  
+- Compliant with **ethical and legal standards** for open-source data use.  
+
+---
+
+## References
+
+- GitHub API: https://docs.github.com/en/rest/issues/issues
+- Hugging Face datasets documentation: https://huggingface.co/docs/datasets