github-issues / README.md
Ruslan10's picture
Update README.md
a69a564 verified
metadata
dataset_info:
  features:
    - name: url
      dtype: string
    - name: repository_url
      dtype: string
    - name: labels_url
      dtype: string
    - name: comments_url
      dtype: string
    - name: events_url
      dtype: string
    - name: html_url
      dtype: string
    - name: id
      dtype: int64
    - name: node_id
      dtype: string
    - name: number
      dtype: int64
    - name: title
      dtype: string
    - name: user
      struct:
        - name: login
          dtype: string
        - name: id
          dtype: int64
        - name: node_id
          dtype: string
        - name: avatar_url
          dtype: string
        - name: gravatar_id
          dtype: string
        - name: url
          dtype: string
        - name: html_url
          dtype: string
        - name: followers_url
          dtype: string
        - name: following_url
          dtype: string
        - name: gists_url
          dtype: string
        - name: starred_url
          dtype: string
        - name: subscriptions_url
          dtype: string
        - name: organizations_url
          dtype: string
        - name: repos_url
          dtype: string
        - name: events_url
          dtype: string
        - name: received_events_url
          dtype: string
        - name: type
          dtype: string
        - name: user_view_type
          dtype: string
        - name: site_admin
          dtype: bool
    - name: labels
      list:
        - name: id
          dtype: int64
        - name: node_id
          dtype: string
        - name: url
          dtype: string
        - name: name
          dtype: string
        - name: color
          dtype: string
        - name: default
          dtype: bool
        - name: description
          dtype: string
    - name: state
      dtype: string
    - name: locked
      dtype: bool
    - name: assignee
      struct:
        - name: login
          dtype: string
        - name: id
          dtype: int64
        - name: node_id
          dtype: string
        - name: avatar_url
          dtype: string
        - name: gravatar_id
          dtype: string
        - name: url
          dtype: string
        - name: html_url
          dtype: string
        - name: followers_url
          dtype: string
        - name: following_url
          dtype: string
        - name: gists_url
          dtype: string
        - name: starred_url
          dtype: string
        - name: subscriptions_url
          dtype: string
        - name: organizations_url
          dtype: string
        - name: repos_url
          dtype: string
        - name: events_url
          dtype: string
        - name: received_events_url
          dtype: string
        - name: type
          dtype: string
        - name: user_view_type
          dtype: string
        - name: site_admin
          dtype: bool
    - name: assignees
      list:
        - name: login
          dtype: string
        - name: id
          dtype: int64
        - name: node_id
          dtype: string
        - name: avatar_url
          dtype: string
        - name: gravatar_id
          dtype: string
        - name: url
          dtype: string
        - name: html_url
          dtype: string
        - name: followers_url
          dtype: string
        - name: following_url
          dtype: string
        - name: gists_url
          dtype: string
        - name: starred_url
          dtype: string
        - name: subscriptions_url
          dtype: string
        - name: organizations_url
          dtype: string
        - name: repos_url
          dtype: string
        - name: events_url
          dtype: string
        - name: received_events_url
          dtype: string
        - name: type
          dtype: string
        - name: user_view_type
          dtype: string
        - name: site_admin
          dtype: bool
    - name: milestone
      dtype: 'null'
    - name: comments
      list: string
    - name: created_at
      dtype: timestamp[s]
    - name: updated_at
      dtype: timestamp[s]
    - name: closed_at
      dtype: timestamp[s]
    - name: author_association
      dtype: string
    - name: type
      dtype: 'null'
    - name: active_lock_reason
      dtype: 'null'
    - name: sub_issues_summary
      struct:
        - name: total
          dtype: int64
        - name: completed
          dtype: int64
        - name: percent_completed
          dtype: int64
    - name: issue_dependencies_summary
      struct:
        - name: blocked_by
          dtype: int64
        - name: total_blocked_by
          dtype: int64
        - name: blocking
          dtype: int64
        - name: total_blocking
          dtype: int64
    - name: body
      dtype: string
    - name: closed_by
      struct:
        - name: login
          dtype: string
        - name: id
          dtype: int64
        - name: node_id
          dtype: string
        - name: avatar_url
          dtype: string
        - name: gravatar_id
          dtype: string
        - name: url
          dtype: string
        - name: html_url
          dtype: string
        - name: followers_url
          dtype: string
        - name: following_url
          dtype: string
        - name: gists_url
          dtype: string
        - name: starred_url
          dtype: string
        - name: subscriptions_url
          dtype: string
        - name: organizations_url
          dtype: string
        - name: repos_url
          dtype: string
        - name: events_url
          dtype: string
        - name: received_events_url
          dtype: string
        - name: type
          dtype: string
        - name: user_view_type
          dtype: string
        - name: site_admin
          dtype: bool
    - name: reactions
      struct:
        - name: url
          dtype: string
        - name: total_count
          dtype: int64
        - name: '+1'
          dtype: int64
        - name: '-1'
          dtype: int64
        - name: laugh
          dtype: int64
        - name: hooray
          dtype: int64
        - name: confused
          dtype: int64
        - name: heart
          dtype: int64
        - name: rocket
          dtype: int64
        - name: eyes
          dtype: int64
    - name: timeline_url
      dtype: string
    - name: performed_via_github_app
      dtype: 'null'
    - name: state_reason
      dtype: string
    - name: draft
      dtype: bool
    - name: pull_request
      struct:
        - name: url
          dtype: string
        - name: html_url
          dtype: string
        - name: diff_url
          dtype: string
        - name: patch_url
          dtype: string
        - name: merged_at
          dtype: timestamp[s]
    - name: is_pull_request
      dtype: bool
  splits:
    - name: train
      num_bytes: 4707820
      num_examples: 1000
  download_size: 1320056
  dataset_size: 4707820
configs:
  - config_name: default
    data_files:
      - split: train
        path: data/train-*

πŸ™ GitHub Issues Dataset

Dataset Size Features License

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

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

# 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

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

# 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 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:

@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