Update README.md

README.md

@@ -293,3 +293,183 @@ configs:
   - split: train
     path: data/train-*
 ---
+
+
+# 🐙 GitHub Issues Dataset
+
+![Dataset Size](https://img.shields.io/badge/Examples-1%2C000-blue)
+![Features](https://img.shields.io/badge/Features-30%2B-8A2BE2)
+![License](https://img.shields.io/badge/License-MIT-informational)
+
+A curated dataset of GitHub issues and pull requests with rich metadata including comments, labels, reactions, assignees, and timeline information. Ideal for training models on software engineering tasks, issue classification, triage automation, and developer behavior analysis.
+
+---
+
+## 📊 Dataset Overview
+
+| Property | Value |
+|----------|-------|
+| **Examples** | 1,000 issues/PRs |
+| **Source** | GitHub API (v3) |
+| **Domains** | Open-source software repositories |
+| **Languages** | Primarily English |
+| **Date Range** | Collected in 2024–2025 |
+| **Avg. Length** | ~1,200 characters per issue body |
+
+### ✨ Key Features
+- ✅ Full issue metadata (title, body, state, timestamps)
+- ✅ Author and assignee information with GitHub profiles
+- ✅ Labels with colors and descriptions
+- ✅ Nested comments (full conversation threads)
+- ✅ Reaction counts (`+1`, `-1`, 🚀, ❤️, etc.)
+- ✅ Pull request detection (`is_pull_request` flag)
+- ✅ Dependency tracking (`blocked_by` / `blocking` relationships)
+- ✅ Sub-issue completion metrics
+
+---
+
+## 🧱 Schema
+
+### Top-Level Fields
+| Field | Type | Description |
+|-------|------|-------------|
+| `url` | `string` | API URL of the issue |
+| `html_url` | `string` | GitHub web URL |
+| `id` / `node_id` | `int64` / `string` | GitHub identifiers |
+| `number` | `int64` | Issue number within repository |
+| `title` | `string` | Issue title |
+| `body` | `string` | Full issue description (Markdown) |
+| `state` | `string` | `open` \| `closed` |
+| `state_reason` | `string` | Reason for closure (`completed`, `not_planned`, etc.) |
+| `locked` | `bool` | Whether conversation is locked |
+| `draft` | `bool` | Whether issue is a draft |
+| `is_pull_request` | `bool` | `True` if this is a PR (not a regular issue) |
+| `created_at` / `updated_at` / `closed_at` | `timestamp` | Lifecycle timestamps |
+| `author_association` | `string` | Author's relationship to repo (`OWNER`, `MEMBER`, `CONTRIBUTOR`, etc.) |
+
+### Nested Structures
+| Field | Structure | Key Subfields |
+|-------|-----------|---------------|
+| `user` | `struct` | `login`, `id`, `type` (`User`/`Bot`), `site_admin` |
+| `assignee` / `assignees` | `struct` / `list` | GitHub user profiles of assignees |
+| `closed_by` | `struct` | User who closed the issue |
+| `labels` | `list` | `name`, `color`, `description`, `default` |
+| `comments` | `list<string>` | Full comment texts in chronological order |
+| `reactions` | `struct` | `total_count`, `+1`, `-1`, `heart`, `rocket`, `eyes`, etc. |
+| `pull_request` | `struct` | PR-specific fields (`merged_at`, diff/patch URLs) |
+| `sub_issues_summary` | `struct` | `total`, `completed`, `percent_completed` |
+| `issue_dependencies_summary` | `struct` | `blocked_by`, `blocking` counts |
+
+> 💡 **Note**: Fields like `milestone`, `type`, and `performed_via_github_app` may contain `null` values for issues where these features aren't used.
+
+---
+
+## 🚀 Usage
+
+### Load with 🤗 Datasets
+```python
+from datasets import load_dataset
+
+# Load the full dataset
+dataset = load_dataset("Ruslan10/github-issues")
+
+# Access the training split
+train_data = dataset["train"]
+
+# Example: Get first issue's title and body
+print(train_data[0]["title"])
+print(train_data[0]["body"][:200] + "...")  # Preview first 200 chars
+```
+
+### Filter Pull Requests vs Issues
+```python
+# Separate PRs from regular issues
+pull_requests = [ex for ex in train_data if ex["is_pull_request"]]
+regular_issues = [ex for ex in train_data if not ex["is_pull_request"]]
+
+print(f"PRs: {len(pull_requests)}, Issues: {len(regular_issues)}")
+```
+
+### Analyze Labels Distribution
+```python
+from collections import Counter
+
+all_labels = []
+for issue in train_data:
+    for label in issue["labels"]:
+        all_labels.append(label["name"])
+
+label_counts = Counter(all_labels).most_common(10)
+print("Top 10 labels:", label_counts)
+```
+
+### Extract Comment Threads
+```python
+# Get all comments for a specific issue
+issue = train_data[42]
+for i, comment in enumerate(issue["comments"]):
+    print(f"Comment {i+1}: {comment[:100]}...")  # Preview
+```
+
+---
+
+## 💡 Example Applications
+
+- **Issue Triage**: Classify issues by priority/severity using labels and metadata
+- **Auto-Tagging**: Predict appropriate labels based on title/body content
+- **Duplicate Detection**: Find similar issues using semantic similarity
+- **PR Prediction**: Forecast whether an issue will become a pull request
+- **Sentiment Analysis**: Analyze developer emotions in comments/reactions
+- **Knowledge Extraction**: Build QA systems over project documentation in issues
+
+---
+
+## ⚠️ Limitations & Considerations
+
+| Aspect | Note |
+|--------|------|
+| **Bias** | Reflects patterns of active OSS projects; may underrepresent niche ecosystems |
+| **Privacy** | All data is from public GitHub repositories (no private data included) |
+| **Language** | Primarily English; limited multilingual support |
+| **Temporal Scope** | Snapshot from collection period; doesn't reflect real-time GitHub state |
+| **Rate Limits** | Original collection respected GitHub API rate limits |
+
+---
+
+## 🔐 License
+
+- **Dataset**: MIT License
+- **Source Data**: Subject to [GitHub Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service) and individual repository licenses
+- **Usage Rights**: For research and educational purposes. Commercial use requires compliance with GitHub's ToS.
+
+> ℹ️ This dataset contains only publicly available information. All rights to original content remain with issue authors and repository owners.
+
+---
+
+## 📚 Citation
+
+If you use this dataset in your research, please cite:
+
+```bibtex
+@dataset{github_issues_2025,
+  author = {Ruslan Prashchurovich},
+  title = {GitHub Issues Dataset},
+  year = {2025},
+  publisher = {Hugging Face},
+  journal = {Hugging Face Datasets},
+  url = {https://huggingface.co/datasets/your-username/github-issues}
+}
+```
+
+---
+
+## 🙏 Acknowledgements
+
+- Data collected via [GitHub REST API v3](https://docs.github.com/en/rest)
+- Inspired by prior work on software engineering datasets (e.g., [IssueSum](https://arxiv.org/abs/2106.06604), [PRSummarizer](https://arxiv.org/abs/2202.07324))
+- Processed using 🤗 Datasets library
+
+---
+
+*Dataset prepared by [Ruslan Prashchurovich] • Updated February 2026*  
+*⚠️ Not affiliated with GitHub Inc. or Microsoft Corporation*