Dataset card update

README.md

@@ -367,3 +367,85 @@ configs:
   - split: train
     path: data/train-*
 ---
+
+# GitHub Issues Dataset
+
+## Dataset Description
+
+This dataset contains issues recorded from GitHub including pull requests collected from the Hugging Face datasets repository using the GitHub REST API.
+
+This dataset was created to meet academic requirements with educational uses like:
+- data collection
+- augmentation
+- transformer pipelines
+- semantic search using FAISS 
+
+---
+
+## Data Collection
+
+The data was collected by using GitHub REST API from the repository below:
+- Repository: 'https://github.com/huggingface/datasets/issues'
+
+The following API endpoints were used:
+- '/issues'
+- `/issues/{issue_number}/comments`
+
+500 GitHub issues and pull requests were collected.
+
+---
+
+## Features in Dataset
+
+Dataset contains:
+- issue titles
+- issue body text
+- issue comments
+- issue labels
+- issue state
+- timestamps
+- pull request metadata
+
+Additional engineered features include:
+- `is_pull_request`
+- `comments`
+
+---
+
+## Augmentation and Processing
+
+The dataset was augmented by:
+
+1. Creating a boolean `is_pull_request` feature to distinguish issues from pull requests.
+
+2. Retrieving issue discussion comments using the GitHub comments API endpoint.
+
+These augmentations improve contextual understanding and semantic retrieval capabilities.
+
+---
+
+## Intended Use
+
+This dataset is intended for:
+- NLP experimentation
+- transformer inference
+- semantic search
+- educational purposes
+- FAISS vector retrieval demonstrations
+
+---
+
+## Limitations
+
+- Dataset only reflects a small portion of one GitHub repository
+- Some issues may contain incomplete or noisy text
+- API results may change over time
+- Dataset may contain technical jargon and inconsistent formatting
+
+---
+
+GitHub Repository:
+https://github.com/huggingface/datasets
+
+GitHub REST API Documentation:
+https://docs.github.com/en/rest